ONTIME API Documentatie

CALL

Deze API biedt de mogelijkheid aan om opdrachten te annuleren

URL	https://api.asx.be/CANCEL/
METHOD	POST

OPGELET : een opdracht annuleren via deze API betekent dat er een AANVRAAG tot ANNULATIE wordt ingediend !!!!
Maw. na het indien van deze annulatie wordt uw aanvraag onderzocht en zal worden beslist of de annulatie kan worden uitgevoerd!

REQUEST / INPUT

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		*	CREATE	Er zal een nieuwe opdracht worden aangemaakt zodra alle controles zijn gebeurd
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
1	verzender
	2	contact	*	Ann Flecyn	Naam van de persoon die de opdracht aanmaakt Max 250 karakters
	2	email	*	info@ontime.be	Emailadres van de persoon die de opdracht aanmaakt Max 250 karakters
1	opdracht		*	ASX0120005042	Opdrachtnummer van de opdracht die mag geannuleerd worden

<?xml version="1.0" encoding="utf-8"?>
<WebOrder> 
    <verwerking>CREATE</verwerking>
    <gebruiker>info@ontime.be</gebruiker>
    <klantnr>1234</klantnr>
    <apipswd>c40b0c360f3d4959b53b103b25759542</apipswd>
    <omgeving>TEST</omgeving>
    <verzender>
        <contact>Ann Flecyn</contact>
        <email>info@ontime.be</email>
    </verzender> 
    <opdracht>ASX0120005042</opdracht>
</WebOrder>

RESPONSE / OUTPUT

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 opdracht aangemaakt	Informatieve opmerkingen

Niveau / Veld			Voorbeeld	Omschrijving
1	status		ERROR
1	remarks
	2	remark	foutieve credentials	Oplijsting van de gevonden fouten

JSON antwoord bij SUCCES

JSON antwoord bij ERROR

XML antwoord bij SUCCES

<?xml version="1.0" encoding="utf-8"?>
<WebAnswer> 
    <status>SUCCESS</status>
    <remarks>
        <remark>uw aanvraag tot annuleren werd succesvol doorgegeven</remark>
    </remarks>
</WebAnswer>

XML antwoord bij ERROR

<?xml version="1.0" encoding="utf-8"?>
<WebAnswer> 
    <status>ERROR</status>
    <remarks>
        <remark>annulatie niet meer mogelijk</remark>
    </remarks>
</WebAnswer>

CONTROLE/TEST

Via deze functie kan u elke JSON of XML input uitproberen.
OPGELET : Deze functie wordt STEEDS in de TEST omgeving uitgevoerd

Uw INPUT string

Het resultaat/antwoord:

opdrachten ANNULEREN