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.

export class TokenDto implements ICommandResponse
{
    public token: string;

    public constructor(init?: Partial<TokenDto>) { (Object as any).assign(this, init); }
}

/** @description Receiving Advice */
// @Api(Description="Receiving Advice")
// @ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType="typeof(DX.Framework.Core.Commands.Dto.TokenDto)", StatusCode=202)
export class UpdateReceivingAdviceClientProcessed
{
    /** @description ReceivingAdvice ID or Token */
    // @ApiMember(Description="ReceivingAdvice ID or Token", ExcludeInSchema=true, ParameterType="path")
    public receivingAdviceId: string;

    /** @description Customer ReceivingAdvice reference in destination system */
    // @ApiMember(Description="Customer ReceivingAdvice reference in destination system")
    public customerReference: string;

    /** @description Date and Time ReceivingAdvice was processed in destination system */
    // @ApiMember(Description="Date and Time ReceivingAdvice was processed in destination system")
    public customerProcessedDate: string;

    public constructor(init?: Partial<UpdateReceivingAdviceClientProcessed>) { (Object as any).assign(this, init); }
}

TypeScript UpdateReceivingAdviceClientProcessed DTOs

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

{
	
}