POST api/Requisition/Ack
Acknowledge Requisition
Request Information
URI Parameters
None.
Body Parameters
List of 1 or more requisition acknowledgements
Collection of Acknowledgement| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientId |
APex Client Id |
integer |
Required |
| DocumentID |
APex Document ID |
integer |
Required |
| ERPReferenceID |
ERP System reference ID; 50 Character max |
string |
None. |
| IsSuccessful |
Acknowledgement result from ERP system: True - Transaction accepted by ERP system, False = Transaction not accepted by ERP system. |
boolean |
Required |
| Message |
Information or error message related to transactions rejected by ERP system; 750 Character max. The value of this message (ERP ID, error message) will be recorded in the document event history. |
string |
None. |
| IsValid |
Result of posting transaction to APex. This value of this will be provided in the response from the API call. |
boolean |
None. |
| PostError |
If the acknowledgement is unable to be processed the Post Error will provide information on why it could not be processed; 1,000 character max |
string |
None. |
Request Formats
application/json, text/json
[
{
"ClientId": 1,
"DocumentID": 2,
"ERPReferenceID": "sample string 3",
"IsSuccessful": true,
"Message": "sample string 5",
"IsValid": true,
"PostError": "sample string 7"
},
{
"ClientId": 1,
"DocumentID": 2,
"ERPReferenceID": "sample string 3",
"IsSuccessful": true,
"Message": "sample string 5",
"IsValid": true,
"PostError": "sample string 7"
}
]
application/xml, text/xml
<ArrayOfAcknowledgement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers.Util">
<Acknowledgement>
<ClientId>1</ClientId>
<DocumentID>2</DocumentID>
<ERPReferenceID>sample string 3</ERPReferenceID>
<IsSuccessful>true</IsSuccessful>
<IsValid>true</IsValid>
<Message>sample string 5</Message>
<PostError>sample string 7</PostError>
</Acknowledgement>
<Acknowledgement>
<ClientId>1</ClientId>
<DocumentID>2</DocumentID>
<ERPReferenceID>sample string 3</ERPReferenceID>
<IsSuccessful>true</IsSuccessful>
<IsValid>true</IsValid>
<Message>sample string 5</Message>
<PostError>sample string 7</PostError>
</Acknowledgement>
</ArrayOfAcknowledgement>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The list of acknowledgements with an update value for IsValid and Post Error
Collection of Acknowledgement| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientId |
APex Client Id |
integer |
Required |
| DocumentID |
APex Document ID |
integer |
Required |
| ERPReferenceID |
ERP System reference ID; 50 Character max |
string |
None. |
| IsSuccessful |
Acknowledgement result from ERP system: True - Transaction accepted by ERP system, False = Transaction not accepted by ERP system. |
boolean |
Required |
| Message |
Information or error message related to transactions rejected by ERP system; 750 Character max. The value of this message (ERP ID, error message) will be recorded in the document event history. |
string |
None. |
| IsValid |
Result of posting transaction to APex. This value of this will be provided in the response from the API call. |
boolean |
None. |
| PostError |
If the acknowledgement is unable to be processed the Post Error will provide information on why it could not be processed; 1,000 character max |
string |
None. |
Response Formats
application/json, text/json
[
{
"ClientId": 1,
"DocumentID": 2,
"ERPReferenceID": "sample string 3",
"IsSuccessful": true,
"Message": "sample string 5",
"IsValid": true,
"PostError": "sample string 7"
},
{
"ClientId": 1,
"DocumentID": 2,
"ERPReferenceID": "sample string 3",
"IsSuccessful": true,
"Message": "sample string 5",
"IsValid": true,
"PostError": "sample string 7"
}
]
application/xml, text/xml
<ArrayOfAcknowledgement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers.Util">
<Acknowledgement>
<ClientId>1</ClientId>
<DocumentID>2</DocumentID>
<ERPReferenceID>sample string 3</ERPReferenceID>
<IsSuccessful>true</IsSuccessful>
<IsValid>true</IsValid>
<Message>sample string 5</Message>
<PostError>sample string 7</PostError>
</Acknowledgement>
<Acknowledgement>
<ClientId>1</ClientId>
<DocumentID>2</DocumentID>
<ERPReferenceID>sample string 3</ERPReferenceID>
<IsSuccessful>true</IsSuccessful>
<IsValid>true</IsValid>
<Message>sample string 5</Message>
<PostError>sample string 7</PostError>
</Acknowledgement>
</ArrayOfAcknowledgement>