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

import 'package:servicestack/servicestack.dart';

class TokenDto implements ICommandResponse, IConvertible
{
    String token = "";

    TokenDto({this.token});
    TokenDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        token = json['token'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'token': token
    };

    getTypeName() => "TokenDto";
    TypeContext? context = _ctx;
}

enum DuplicateOrderReasonCode
{
    OrderExist,
}

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

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

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

    /**
    * Date and Time order was identified as duplicate
    */
    // @ApiMember(Description="Date and Time order was identified as duplicate")
    DateTime? duplicateDate;

    DuplicatedOrder({this.orderId,this.duplicateReasonCode,this.duplicateReasonCodeDescription,this.duplicateDate});
    DuplicatedOrder.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        orderId = json['orderId'];
        duplicateReasonCode = JsonConverters.fromJson(json['duplicateReasonCode'],'DuplicateOrderReasonCode',context!);
        duplicateReasonCodeDescription = json['duplicateReasonCodeDescription'];
        duplicateDate = JsonConverters.fromJson(json['duplicateDate'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'orderId': orderId,
        'duplicateReasonCode': JsonConverters.toJson(duplicateReasonCode,'DuplicateOrderReasonCode',context!),
        'duplicateReasonCodeDescription': duplicateReasonCodeDescription,
        'duplicateDate': JsonConverters.toJson(duplicateDate,'DateTime',context!)
    };

    getTypeName() => "DuplicatedOrder";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'stf_api_uat.data_xchange.co.za', types: <String, TypeInfo> {
    'TokenDto': TypeInfo(TypeOf.Class, create:() => TokenDto()),
    'DuplicateOrderReasonCode': TypeInfo(TypeOf.Enum, enumValues:DuplicateOrderReasonCode.values),
    'DuplicatedOrder': TypeInfo(TypeOf.Class, create:() => DuplicatedOrder()),
});

Dart 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

{}