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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


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

    /**
    * Reason code
    */
    @ApiMember(Description="Reason code")
    open var duplicateReasonCode:DuplicateOrderReasonCode? = null

    /**
    * Description
    */
    @ApiMember(Description="Description")
    open var duplicateReasonCodeDescription:String? = null

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

enum class DuplicateOrderReasonCode
{
    OrderExist,
}

open class TokenDto : ICommandResponse
{
    open var token:UUID? = null
}

Kotlin DuplicatedOrder DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}