DX STF Client API

<back to all web services

DuplicatedOrder

Order Requests

Order

Requires Authentication
The following routes are available for this service:
PUT/api/order/{OrderId}/duplicateMark order as duplicate
namespace DX.Framework.Core.Commands.Dto

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type TokenDto() = 
        member val Token:Guid = new Guid() with get,set

    type DuplicateOrderReasonCode =
        | OrderExist = 0

    ///<summary>
    ///Order
    ///</summary>
    [<Api(Description="Order")>]
    [<ApiResponse(Description="Command received", IsDefaultResponse=true, StatusCode=200)>]
    [<AllowNullLiteral>]
    type DuplicatedOrder() = 
        ///<summary>
        ///Order ID or Token
        ///</summary>
        [<ApiMember(Description="Order ID or Token", ExcludeInSchema=true, ParameterType="path")>]
        member val OrderId:Guid = new Guid() with get,set

        ///<summary>
        ///Reason code
        ///</summary>
        [<ApiMember(Description="Reason code")>]
        member val DuplicateReasonCode:DuplicateOrderReasonCode = new DuplicateOrderReasonCode() with get,set

        ///<summary>
        ///Description
        ///</summary>
        [<ApiMember(Description="Description")>]
        member val DuplicateReasonCodeDescription:String = null with get,set

        ///<summary>
        ///Date and Time order was identified as duplicate
        ///</summary>
        [<ApiMember(Description="Date and Time order was identified as duplicate")>]
        member val DuplicateDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

F# 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

{}