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

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports DX.STF.Application.ClientApi.Messages.Order
Imports DX.STF.Models.Enums
Imports DX.Framework.Core.Commands.Dto

Namespace Global

    Namespace DX.Framework.Core.Commands.Dto

        Public Partial Class TokenDto
            Implements ICommandResponse
            Public Overridable Property Token As Guid
        End Class
    End Namespace

    Namespace DX.STF.Application.ClientApi.Messages.Order

        '''<Summary>
        '''Order
        '''</Summary>
        <Api(Description:="Order")>
        <ApiResponse(Description:="Command received", IsDefaultResponse:=true, StatusCode:=200)>
        Public Partial Class DuplicatedOrder
            '''<Summary>
            '''Order ID or Token
            '''</Summary>
            <ApiMember(Description:="Order ID or Token", ExcludeInSchema:=true, ParameterType:="path")>
            Public Overridable Property OrderId As Guid

            '''<Summary>
            '''Reason code
            '''</Summary>
            <ApiMember(Description:="Reason code")>
            Public Overridable Property DuplicateReasonCode As DuplicateOrderReasonCode

            '''<Summary>
            '''Description
            '''</Summary>
            <ApiMember(Description:="Description")>
            Public Overridable Property DuplicateReasonCodeDescription As String

            '''<Summary>
            '''Date and Time order was identified as duplicate
            '''</Summary>
            <ApiMember(Description:="Date and Time order was identified as duplicate")>
            Public Overridable Property DuplicateDate As Date?
        End Class
    End Namespace

    Namespace DX.STF.Models.Enums

        Public Enum DuplicateOrderReasonCode
            OrderExist
        End Enum
    End Namespace
End Namespace

VB.NET 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

{}