ONTIME API Documentatie

CALL

This API provides the ability to retrieve all possible statuses

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

REQUEST / INPUT

Below is the structure used as input, including an illustrative example and more information for each field.
You may choose whether to send the data to us via JSON or XML

Level/Field		Mandatory	Example	Description
1	verwerking	*	STATUS
1	gebruiker	*	info@ontime.be	Email address on which the API account was defined. Max 250 characters
1	klantnr	*	1234	This is the customer number at ON TIMELogistics. numeric, without preceding zeroes
1	apipswd	*	c40b0c360f3d4959b53b103b25759542	Password of the API account
1	omgeving	*	TEST	TEST = TEST environment LIVE = LIVE environment

JSON example

XML example

<?xml version="1.0" encoding="utf-8"?>
<WebOrder> 
    <verwerking>STATUS</verwerking>
    <gebruiker>info@ontime.be</gebruiker>
    <klantnr>1234</klantnr>
    <apipswd>c40b0c360f3d4959b53b103b25759542</apipswd>
    <omgeving>TEST</omgeving>
</WebOrder>

RESPONSE / OUTPUT

Below is the structure used as output, including an illustrative example and more information for each field.
If you sent with JSON, you will receive JSON, idem with XML

Level/Field				Example	Description
1	status			SUCCESS
1	remarks
	2	remark		Er werden 20 statussen gevonden	Informative comments
1	overzicht
	2	status
		3	type	status	status = General status of the assignment tag = Status type of detail lines navi = General status of a distribution order
		3	code	AN	Status code
		3	NL	Geannuleerd	Dutch description of the status
		3	FR	Annulée	French description of status
		3	EN	Cancelled	English description of status

Level/Field			Example	Description
1	status		ERROR
1	remarks
	2	remark	foutieve credentials	List of errors found

JSON response at SUCCESS

JSON response to ERROR

XML response at SUCCESS

<?xml version="1.0" encoding="utf-8"?>
<WebAnswer> 
    <status>SUCCESS</status>
    <remarks>
        <remark>er werden 2 statussen gevonden</remark>
    </remarks>
    <overzicht>
        <status>
            <type>status</type>
            <code>AN</code>
            <NL>Geannuleerd</NL>
            <FR>Annulée</FR>
            <EN>Cancelled</EN>
        </status>
        <status>
            <type>status</type>
            <code>AN</code>
            <NL>Geannuleerd</NL>
            <FR>Annulée</FR>
            <EN>Cancelled</EN>
        </status>
    </overzicht>
</WebAnswer>

XML response to ERROR

<?xml version="1.0" encoding="utf-8"?>
<WebAnswer> 
    <status>ERROR</status>
    <remarks>
        <remark>foutieve credentials</remark>
    </remarks>
</WebAnswer>

CONTROL/TEST

Through this function, you can try out any JSON or XML input.
ATTENTION : This function is ALWAYS performed in the TEST environment

Your INPUT string

The result/response:

TRACK » STATUSES