Deze API biedt de mogelijkheid om steeds de actieve, mogelijke instructies op te halen voor uw bedrijf/klantennummer.
| URL | https://api.asx.be/STAD/ |
|---|---|
| METHOD | POST |
Hieronder krijgt u de structuur die gehanteerd wordt als input, inclusief een illustrerend voorbeeld en meer informatie per veld.
U mag zelf de keuze maken of u de gegevens naar ons toestuurt via JSON of XML
| Niveau / Veld | Verplicht | Voorbeeld | Omschrijving | |||||
|---|---|---|---|---|---|---|---|---|
| 1 | verwerking | * | INSTRUCTIES | Een overzicht van alle mogelijke instructies voor uw klantnummer wordt opgehaald.- | ||||
| 1 | gebruiker | * | info@ontime.be | Emailadres waarop de API-account werd gedefinieerd. Max 250 karakters |
||||
| 1 | klantnr | * | 1234 | Dit is het klantennummer bij ON TIME Logistics. numeriek, zonder voorgaande zeroes | ||||
| 1 | apipswd | * | c40b0c360f3d4959b53b103b25759542 | Paswoord van de API-account | ||||
| 1 | omgeving | * | TEST | TEST = TEST omgeving LIVE = LIVE omgeving |
||||
<?xml version="1.0" encoding="utf-8"?> <WebOrder> <verwerking>INSTRUCTIES</verwerking> <gebruiker>info@ontime.be</gebruiker> <klantnr>1234</klantnr> <apipswd>c40b0c360f3d4959b53b103b25759542</apipswd> <omgeving>TEST</omgeving> </WebOrder>
Hieronder krijgt u de structuur die gehanteerd wordt als output, inclusief een illustrerend voorbeeld en meer informatie per veld.
Indien u heeft gestuurd met JSON, zal u JSON ontvangen, idem met XML
| Niveau / Veld | Voorbeeld | Omschrijving | |||||
|---|---|---|---|---|---|---|---|
| 1 | status | SUCCESS | |||||
| 1 | remarks | ||||||
| 2 | remark | Er werd 1 instructies gevonden | Informatieve opmerkingen | ||||
| 1 | instructies | ||||||
| 2 | instructie | ||||||
| 3 | oms | AFGEVEN ATTEST / CERTIFICAAT | De instructie | ||||
| 3 | schip | 0 | 1= Het veld schip dient verplicht ingevuld te worden 0 = Niet verplicht |
||||
| 3 | haven | 0 | 1=Verplicht 0=Niet verplicht |
||||
| 3 | contbl | 0 | 1=Verplicht 0=Niet verplicht |
||||
| Niveau / Veld | Voorbeeld | Omschrijving | |||||
|---|---|---|---|---|---|---|---|
| 1 | status | ERROR | |||||
| 1 | remarks | ||||||
| 2 | remark | foutieve credentials | Oplijsting van de gevonden fouten | ||||
<?xml version="1.0" encoding="utf-8"?> <WebAnswer> <status>SUCCESS</status> <remarks> <remark>er werden 2 intructies gevonden</remark> </remarks> <instructies> <instructie> <oms>AFGEVEN ATTEST / CERTIFICAAT</oms> <haven>0</haven> <schip>0</schip> <contbl>0</contbl> </instructie> <instructie> <oms>AFGEVEN BL</oms> <haven>1</haven> <schip>1</schip> <contbl>1</contbl> </instructie> </instructies> </WebAnswer>
<?xml version="1.0" encoding="utf-8"?> <WebAnswer> <status>ERROR</status> <remarks> <remark>foutieve credentials</remark> </remarks> </WebAnswer>
Via deze functie kan u elke JSON of XML input uitproberen.
OPGELET : Deze functie wordt STEEDS in de TEST omgeving uitgevoerd