<back to all web services
UpdateReceivingAdviceClientProcessed
Receiving Advice Requests
Receiving Advice
The following routes are available for this service:| PUT | /api/receivingAdvice/{ReceivingAdviceId}/processed | Update ReceivingAdvice as customer processed, will also acknowledge ReceivingAdvice if not yet set. | |
|---|
UpdateReceivingAdviceClientProcessed Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ReceivingAdviceId | path | Guid | No | ReceivingAdvice ID or Token |
| CustomerReference | body | string | Yes | Customer ReceivingAdvice reference in destination system |
| CustomerProcessedDate | body | DateTime | No | Date and Time ReceivingAdvice was processed in destination system |
TokenDto Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Token | form | Guid | No | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
HTTP + JSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
PUT /api/receivingAdvice/{ReceivingAdviceId}/processed HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
customerReference: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
}