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

import Foundation
import ServiceStack

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

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

    /**
    * Description
    */
    // @ApiMember(Description="Description")
    public var duplicateReasonCodeDescription:String

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

    required public init(){}
}

public enum DuplicateOrderReasonCode : String, Codable
{
    case OrderExist
}

public class TokenDto : ICommandResponse, Codable
{
    public var token:String

    required public init(){}
}

Swift DuplicatedOrder DTOs

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

HTTP + CSV

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

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

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

{}