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

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

namespace DX.Framework.Core.Commands.Dto
{
    public partial class TokenDto
        : ICommandResponse
    {
        public virtual Guid Token { get; set; }
    }

}

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 virtual Guid OrderId { get; set; }

        ///<summary>
        ///Reason code
        ///</summary>
        [ApiMember(Description="Reason code")]
        public virtual DuplicateOrderReasonCode DuplicateReasonCode { get; set; }

        ///<summary>
        ///Description
        ///</summary>
        [ApiMember(Description="Description")]
        public virtual string DuplicateReasonCodeDescription { get; set; }

        ///<summary>
        ///Date and Time order was identified as duplicate
        ///</summary>
        [ApiMember(Description="Date and Time order was identified as duplicate")]
        public virtual DateTime? DuplicateDate { get; set; }
    }

}

namespace DX.STF.Models.Enums
{
    public enum DuplicateOrderReasonCode
    {
        OrderExist,
    }

}

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

{}