DX STF Client API

<back to all web services

UpdateReceivingAdviceClientProcessed

Receiving Advice Requests

Receiving Advice

Requires Authentication
The following routes are available for this service:
PUT/api/receivingAdvice/{ReceivingAdviceId}/processedUpdate ReceivingAdvice as customer processed, will also acknowledge ReceivingAdvice if not yet set.
"use strict";
export class TokenDto {
    /** @param {{token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    token;
}
export class UpdateReceivingAdviceClientProcessed {
    /** @param {{receivingAdviceId?:string,customerReference?:string,customerProcessedDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description ReceivingAdvice ID or Token */
    receivingAdviceId;
    /**
     * @type {string}
     * @description Customer ReceivingAdvice reference in destination system */
    customerReference;
    /**
     * @type {string}
     * @description Date and Time ReceivingAdvice was processed in destination system */
    customerProcessedDate;
}

JavaScript UpdateReceivingAdviceClientProcessed DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"customerReference":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}