Module endpoint.AdressenSuche
AdressenSuche - CASYMIR REST API Standard Endpunkt AdressenSuche
Methods
| Methods |
Request GET AdressenSuche
| GET-Request-Field-Definition | |
| GET-Request-Usage | |
| GET-Response-Field-Definition | |
| GET-Response |
AdressenSuche-Request-Handler (Internal)
| AdressenSuche (DB, EndUrl, Pattern, Methode, UserName, QueryStr, BodyTable) | Endpunkt Handler. |
Methods
Request GET AdressenSuche
- GET-Request-Field-Definition
-
Fields:
- AdrSprache varchar(4) -- Sprache des Kunden ISO-639-2B Mapping (optional)
- EmailAdress varchar(255) -- EmailAdresse (optional)
- AdrAdresse1 varchar(60) -- Strasse Hausnummer (optional)
- AdrAdresse2 varchar(60) -- Zusatz (optional)
- AdrFax varchar(28) -- Faxnummer (optional)
- AdrFirma varchar(36) -- Firmenname (optional)
- AdrFirma2 varchar(36) -- Firmennamen zusatz (optional)
- AdrVorname varchar(36) --Vorname (optional)
- AdrName varchar(36) -- Nachname (optional)
- AdrTelex varchar(28) -- Mobilnummer (optional)
- AdrTf1 varchar(28) -- Direkt Telefon (optional)
- AdrTf2 varchar(28) -- Telefon Zentrale (optional)
- OrtLand varchar(4) -- Land ISO 3166 ALPHA-2 (optional)
- OrtName varchar(48) -- Ortsnamen (optional)
- OrtPLZ varchar(10) -- Postleitzahl (optional)
- GET-Request-Usage
-
Usage:
GET /www/adressensuche?{EmailAdress} - GET-Response-Field-Definition
-
Fields:
- KundLief int -- Lieferadresse IDKey
- KundRech int -- Rechnungsadresse IDKey
- KundKontakt int -- Kontaktsadresse IDKey
- DebiNr string -- Eindeutige Bezeichnung des Kunden
- links table -- Verlinkungen
- href varchar(2048) -- Verweis
- type varchar(2048) -- type des Verweis
- rel varchar(2048) -- relation des Verweis
- GET-Response
-
Es gibt nur einen Response wenn eine Suche einem Kunden zugewiesen werden kann.
Usage:
GET /www/adressensuche?AdrFirma=Firme Test&EmailAdress=test3@Test.de&OrtLand=CH&AdrSprache=ger {"data": { "KundRech": 3352, "DebiNr": "300050", "KundKontakt": 3352, "KundLief": 3353, "links": [ { "rel": "adressen KundRech", "type": "GET", "href": "https://casyrest.opag.loc/www/adressen/3352" }, { "rel": "adressen KundRech", "type": "PATCH", "href": "https://casyrest.opag.loc/www/adressen/3352" }, { "rel": "adressen KundKontakt", "type": "GET", "href": "https://casyrest.opag.loc/www/adressen/3352" }, { "rel": "adressen KundKontakt", "type": "PATCH", "href": "https://casyrest.opag.loc/www/adressen/3352" }, { "rel": "adressen KundLief", "type": "GET", "href": "https://casyrest.opag.loc/www/adressen/3353" }, { "rel": "adressen KundLief", "type": "PATCH", "href": "https://casyrest.opag.loc/www/adressen/3353" }, { "rel": "kunden", "type": "GET", "href": "https://casyrest.opag.loc/www/kunden/300050" } ] }}
AdressenSuche-Request-Handler (Internal)
- AdressenSuche (DB, EndUrl, Pattern, Methode, UserName, QueryStr, BodyTable)
-
Endpunkt Handler.
Firmen-Attribut: RESTWEBSHOP
Parameters:
- DB UserData -- Datenbank Verbindung
- EndUrl string -- Enthält die Ausgelesene URI aus der Datenbank
- Pattern string -- Enthält den Patter Teil der URI else nil
- Methode string -- HTTP Methode
- UserName string -- Benutzer der Angemeldet wurde
- QueryStr string -- Orginal String ohne Hex Zeichen
- BodyTable table -- Request Body
Returns:
-
table
retBody