1201 API Post
Introduction
The purpose of this service is to save new PreAdvice to Vision database,
Request
Request URL POST : https://<pathtoapi>/service/PreAdvice
POST Body structure : PA XML Structure
Response
Response body will have new tag <RES> attached with input XML which will have information about the response.
<RES>
<Code></Code>
<Message></Message>
</RES>
Code will be 200 or 400, 200 is for success, if the code is 400 node <Message> will have reason for failure
HTTP Response Codes
Code | Message |
---|---|
200 | OK, All request processed |
406 | Input XML validation failed, response body will have reason for failure |
429 | API access restricted (Exceeded the rate limit / access not allowed) |
207 | Multi-Status, <RES> tag have more information |
400 | Request processing all record failed, <RES> tag have more information |
Response samples
Code : 200
The response body depends on the configuration applied to your warehouse / API user account, for data posted directly into the main system a record by record response is given as below, alternatively ‘Data saved for processing’ will be returned.
<PREADVICES>
<PA>
<HD>
<CustomerPONumber>API_TEST1</CustomerPONumber>
<CustomerCode>JOE</CustomerCode>
</HD>
<RES>
<Code>200</Code>
<Message>Preadvice processed</Message>
</RES>
</PA>
</PREADVICES>
Â
Code : 207
Â
Code : 400
Â
Code : 406 Response Body
Â
Copyright Ontech Solutions 2017-2024. All rights reserved, no part may be replicated or distributed without the express permission of the owner.