Module endpoint.Adressen
Adressen - CASYMIR REST API Standard Endpunkt Adressen
Methods
| Methods |
Request GET Adressen
| GET-Request-Field-Definition | |
| GET-Request-Usage | |
| GET-Response-Field-Definition | |
| GET-Response | |
| GET-Response |
Request PATCH Adressen
| PATCH-Request-Field-Definition | |
| PATCH-Request-Usage | |
| PATCH-Response-Field-Definition | |
| PATCH-Response |
Adressen-Request-Handler (Internal)
| Adressen (DB, EndUrl, Pattern, Methode, UserName, QueryStr, BodyTable) | Endpunkt Handler. |
Methods
Request GET Adressen
- GET-Request-Field-Definition
-
Fields:
- AdrNr int -- Adressnummer
- debinr string -- Eindeutige Bezeichnung des Kunden
- GET-Request-Usage
-
Usage:
GET /www/adressen/{AdrNr} GET /www/adressen?debinr={debinr} - GET-Response-Field-Definition
-
Fields:
- AdrSprache varchar(4) -- Sprache des Kunden ISO-639-2B Mapping
- EmailAdress varchar(255) -- EmailAdresse
- AdrAdresse1 varchar(60) -- Strasse Hausnummer
- AdrAdresse2 varchar(60) -- Zusatz
- AdrAnrede int -- Z.B. Anrede 0 = Firma/Allgemein, 1 = Herr, 2 = Frau
- AdrAnredeText string -- Bezeichnung Anrede
- AdrFax varchar(28) -- Faxnummer
- AdrFirma varchar(36) -- Firmenname
- AdrFirma2 varchar(36) -- Firmennamen zusatz
- AdrVorname varchar(36) --Vorname
- AdrName varchar(36) -- Nachname
- AdrTelex varchar(28) -- Mobilnummer
- AdrTf1 varchar(28) -- Direkt Telefon
- AdrTf2 varchar(28) -- Telefon Zentrale
- OrtLand varchar(4) -- Land ISO 3166 ALPHA-2
- OrtName varchar(48) -- Ortsnamen
- OrtPLZ varchar(10) -- Postleitzahl
- GET-Response
-
Usage:
GET /www/adressen/76 {"data": { "AdrSprache": "ger", "OrtPLZ": "4153", "AdrFirma": "Crown Obrist AG", "AdrTf1": "0041 61 7152424", "OrtLand": "CH", "AdrAnrede": 0, "OrtName": "Reinach", "AdrAdresse1": "Römerstrasse 83" }}
- GET-Response
-
Usage:
GET /www/adressen?debinr=100075 { "count": 3, "success": true, "data": { "KundKontakt": [ { "links": [ { "rel": "adressen", "type": "GET", "href": "https://casyrest.opag.loc/www/adressen/146" }], "AdrFirma": "Bauer-Lustig", "AdrTf1": "0049 6831 555 54", "AdrNr": 146, "AdrVorname": "Frau Dipl. Ing.", "AdrAdresse2": "Hauptstraße 15", "AdrAdresse1": "Heilpraktikerin", "AdrSprache": "ger", "OrtName": "Schwalbach", "EmailAdress": "uzuwe@d", "OrtLand": "DE", "AdrAnrede": 2, "AdrName": "Lelia", "OrtPLZ": "66773" }, { "AdrFirma2": "Lustig Lustig", "AdrFirma": "", "AdrTf1": "", "AdrNr": 3343, "AdrAdresse2": "", "AdrAdresse1": "Oberwilerstrasse 50", "AdrFax": "", "OrtLand": "CH", "AdrAnrede": 0, "AdrTf2": "", "links": [ { "rel": "adressen", "type": "GET", "href": "https://casyrest.opag.loc/www/adressen/3343" }], "AdrSprache": "ger", "EmailAdress": "", "OrtName": "Binningen", "AdrVorname": "", "AdrName": "", "OrtPLZ": "4102" }, { "AdrFirma2": "", "AdrFirma": "", "AdrTf1": "", "AdrNr": 3341, "AdrAdresse2": "", "AdrAdresse1": "Oberwilerstrasse 56", "AdrFax": "", "OrtLand": "CH", "AdrAnrede": 1, "AdrTf2": "", "links": [ { "rel": "adressen", "type": "GET", "href": "https://casyrest.opag.loc/www/adressen/3341" }], "AdrSprache": "ger", "EmailAdress": "", "OrtName": "Binningen", "AdrVorname": "Bauer", "AdrName": "Lustig", "OrtPLZ": "4102" } ], "KundLief": [ { "links": [ { "rel": "adressen", "type": "GET", "href": "https://casyrest.opag.loc/www/adressen/146" }], "AdrFirma": "Bauer-Lustig", "AdrTf1": "0049 6831 555 54", "AdrNr": 146, "AdrVorname": "Frau Dipl. Ing.", "AdrAdresse2": "Hauptstraße 15", "AdrAdresse1": "Heilpraktikerin", "AdrSprache": "ger", "OrtName": "Schwalbach", "EmailAdress": "uzuwe@d", "OrtLand": "DE", "AdrAnrede": 2, "AdrName": "Lelia", "OrtPLZ": "66773" }, { "AdrFirma2": "", "AdrFirma": "", "AdrTf1": "", "AdrNr": 3341, "AdrAdresse2": "", "AdrAdresse1": "Oberwilerstrasse 56", "AdrFax": "", "OrtLand": "CH", "AdrAnrede": 1, "AdrTf2": "", "links": [ { "rel": "adressen", "type": "GET", "href": "https://casyrest.opag.loc/www/adressen/3341" }], "AdrSprache": "ger", "EmailAdress": "", "OrtName": "Binningen", "AdrVorname": "Bauer", "AdrName": "Lustig", "OrtPLZ": "4102" } ], "KundRech": [ { "links": [ { "rel": "adressen", "type": "GET", "href": "https://casyrest.opag.loc/www/adressen/146" }], "AdrFirma": "Bauer-Lustig", "AdrTf1": "0049 6831 555 54", "AdrNr": 146, "AdrVorname": "Frau Dipl. Ing.", "AdrAdresse2": "Hauptstraße 15", "AdrAdresse1": "Heilpraktikerin", "AdrSprache": "ger", "OrtName": "Schwalbach", "EmailAdress": "uzuwe@d", "OrtLand": "DE", "AdrAnrede": 2, "AdrName": "Lelia", "OrtPLZ": "66773" }, { "AdrFirma2": "", "AdrFirma": "", "AdrTf1": "", "AdrNr": 3341, "AdrAdresse2": "", "AdrAdresse1": "Oberwilerstrasse 56", "AdrFax": "", "OrtLand": "CH", "AdrAnrede": 1, "AdrTf2": "", "links": [ { "rel": "adressen", "type": "GET", "href": "https://casyrest.opag.loc/www/adressen/3341" }], "AdrSprache": "ger", "EmailAdress": "", "OrtName": "Binningen", "AdrVorname": "Bauer", "AdrName": "Lustig", "OrtPLZ": "4102" } ] } }
Request PATCH Adressen
- PATCH-Request-Field-Definition
-
Fields:
- AdrNr int -- Adressen Nummer
- AdrSprache char(3) -- Sprache des Kunden ISO-639-2B Mapping
- EmailAdress varchar(255) -- EmailAdresse
- AdrAdresse1 varchar(60) -- Strasse Hausnummer
- AdrAdresse2 varchar(60) -- Zusatz
- AdrAnrede int -- Anrede 0 = Firma/Allgemein, 1 = Herr, 2 = Frau
- AdrFax varchar(28) -- Faxnummer
- AdrFirma varchar(36) -- Firmenname
- AdrFirma2 varchar(36) -- Firmennamen zusatz
- AdrVorname varchar(36) --Vorname
- AdrName varchar(36) -- Nachname
- AdrTelex varchar(28) -- Mobilnummer
- AdrTf1 varchar(28) -- Direkt Telefon
- AdrTf2 varchar(28) -- Telefon Zentrale
- OrtLand varchar(4) -- Land ISO 3166 ALPHA-2
- OrtName varchar(48) -- Ortsnamen
- OrtPLZ varchar(10) -- Postleitzahl
- PATCH-Request-Usage
-
Usage:
PATCH /www/adressen/{AdrNr} { "AdrSprache": "ger", "Anrede": "0", "AdrFirma": "Muster AG", "AdrTf1": "0041 61 1234567", "OrtPLZ": "4153", "OrtLand": "CH", "OrtName": "Reinach", "AdrAdresse1": "MusterWeg 83" } - PATCH-Response-Field-Definition
- PATCH-Response
-
Usage:
HTTP/1.1 204 No Content
Adressen-Request-Handler (Internal)
- Adressen (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