DX STF Client API

<back to all web services

AcknowledgeReceivingAdvice

Receiving Advice Requests

Receiving Advice

Requires Authentication
The following routes are available for this service:
PUT/api/receivingAdvice/{ReceivingAdviceId}/acknowledgeAcknowledge ReceivingAdvice as received
"use strict";
export class AcknowledgeReceivingAdvice {
    /** @param {{receivingAdviceId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    receivingAdviceId;
}

JavaScript AcknowledgeReceivingAdvice DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /api/receivingAdvice/{ReceivingAdviceId}/acknowledge HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AcknowledgeReceivingAdvice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Application.ClientApi.Messages.ReceivingAdvice">
  <ReceivingAdviceId>00000000-0000-0000-0000-000000000000</ReceivingAdviceId>
</AcknowledgeReceivingAdvice>