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

public class dtos
{

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

        /**
        * Reason code
        */
        @ApiMember(Description="Reason code")
        public DuplicateOrderReasonCode duplicateReasonCode = null;

        /**
        * Description
        */
        @ApiMember(Description="Description")
        public String duplicateReasonCodeDescription = null;

        /**
        * Date and Time order was identified as duplicate
        */
        @ApiMember(Description="Date and Time order was identified as duplicate")
        public Date duplicateDate = null;
        
        public UUID getOrderId() { return orderId; }
        public DuplicatedOrder setOrderId(UUID value) { this.orderId = value; return this; }
        public DuplicateOrderReasonCode getDuplicateReasonCode() { return duplicateReasonCode; }
        public DuplicatedOrder setDuplicateReasonCode(DuplicateOrderReasonCode value) { this.duplicateReasonCode = value; return this; }
        public String getDuplicateReasonCodeDescription() { return duplicateReasonCodeDescription; }
        public DuplicatedOrder setDuplicateReasonCodeDescription(String value) { this.duplicateReasonCodeDescription = value; return this; }
        public Date getDuplicateDate() { return duplicateDate; }
        public DuplicatedOrder setDuplicateDate(Date value) { this.duplicateDate = value; return this; }
    }

    public static enum DuplicateOrderReasonCode
    {
        OrderExist;
    }

    public static class TokenDto implements ICommandResponse
    {
        public UUID token = null;
        
        public UUID getToken() { return token; }
        public TokenDto setToken(UUID value) { this.token = value; return this; }
    }

}

Java 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

{}