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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TokenDto(ICommandResponse):
    token: Optional[str] = None


class DuplicateOrderReasonCode(str, Enum):
    ORDER_EXIST = 'OrderExist'


# @Api(Description="Order")
# @ApiResponse(Description="Command received", IsDefaultResponse=true, StatusCode=200)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DuplicatedOrder:
    """
    Order
    """

    # @ApiMember(Description="Order ID or Token", ExcludeInSchema=true, ParameterType="path")
    order_id: Optional[str] = None
    """
    Order ID or Token
    """


    # @ApiMember(Description="Reason code")
    duplicate_reason_code: Optional[DuplicateOrderReasonCode] = None
    """
    Reason code
    """


    # @ApiMember(Description="Description")
    duplicate_reason_code_description: Optional[str] = None
    """
    Description
    """


    # @ApiMember(Description="Date and Time order was identified as duplicate")
    duplicate_date: Optional[datetime.datetime] = None
    """
    Date and Time order was identified as duplicate
    """

Python 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

{}