DX STF Client API

DuplicatedOrder

Order Requests

Order

The following routes are available for this service:
PUT	/api/order/{OrderId}/duplicate	Mark order as duplicate


export class TokenDto implements ICommandResponse
{
    public token: string;

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

export enum DuplicateOrderReasonCode
{
    OrderExist = 'OrderExist',
}

/** @description Order */
// @Api(Description="Order")
// @ApiResponse(Description="Command received", IsDefaultResponse=true, StatusCode=200)
export class DuplicatedOrder
{
    /** @description Order ID or Token */
    // @ApiMember(Description="Order ID or Token", ExcludeInSchema=true, ParameterType="path")
    public orderId: string;

    /** @description Reason code */
    // @ApiMember(Description="Reason code")
    public duplicateReasonCode: DuplicateOrderReasonCode;

    /** @description Description */
    // @ApiMember(Description="Description")
    public duplicateReasonCodeDescription: string;

    /** @description Date and Time order was identified as duplicate */
    // @ApiMember(Description="Date and Time order was identified as duplicate")
    public duplicateDate?: string;

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

TypeScript DuplicatedOrder 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/order/{OrderId}/duplicate HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"duplicateReasonCode":"OrderExist","duplicateReasonCodeDescription":"String","duplicateDate":"0001-01-01"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}