ONTIME API Documentatie

CALL

This API offers the ability to cancel jobs

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

ATTENTION : cancelling an order via this API means submitting a CANCELLATION REQUEST !!!!
I.o.w. after submitting this cancellation, your application will be examined and it will be decided whether the cancellation can be implemented!

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		*	CREATE	A new job will be created once all the checks have been done
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
1	verzender
	2	contact	*	Ann Flecyn	Name of the person creating the order Max 250 characters
	2	email	*	info@ontime.be	Email address of the person creating the order Max 250 characters
1	opdracht		*	ASX0120005042	Job number of the job that may be cancelled

<?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

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 werd 1 opdracht aangemaakt	Informative comments

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>uw aanvraag tot annuleren werd succesvol doorgegeven</remark>
    </remarks>
</WebAnswer>

XML response to ERROR

<?xml version="1.0" encoding="utf-8"?>
<WebAnswer> 
    <status>ERROR</status>
    <remarks>
        <remark>annulatie niet meer mogelijk</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:

CANCEL orders