Trendsic Platform Service

<back to all web services

OrderHeadersRequest

The following routes are available for this service:
GET/v1/OrderHeaders/{ID}
GET,POST,OPTIONS/v1/OrderHeaders
POST/v1/OrderHeaders/Agent/{AgentID}
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class Address implements IConvertible
{
    int? ID;
    int? AddressTypeID;
    String? AddressContact;
    String? AttentionTo;
    String? AddressLine1;
    String? AddressLine2;
    String? AddressLine3;
    String? AddressCity;
    String? AddressState;
    String? AddressZip;
    String? AddressCountry;
    String? PhoneNumber;
    String? FaxNumber;
    String? UID;
    String? Name;

    Address({this.ID,this.AddressTypeID,this.AddressContact,this.AttentionTo,this.AddressLine1,this.AddressLine2,this.AddressLine3,this.AddressCity,this.AddressState,this.AddressZip,this.AddressCountry,this.PhoneNumber,this.FaxNumber,this.UID,this.Name});
    Address.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        AddressTypeID = json['AddressTypeID'];
        AddressContact = json['AddressContact'];
        AttentionTo = json['AttentionTo'];
        AddressLine1 = json['AddressLine1'];
        AddressLine2 = json['AddressLine2'];
        AddressLine3 = json['AddressLine3'];
        AddressCity = json['AddressCity'];
        AddressState = json['AddressState'];
        AddressZip = json['AddressZip'];
        AddressCountry = json['AddressCountry'];
        PhoneNumber = json['PhoneNumber'];
        FaxNumber = json['FaxNumber'];
        UID = json['UID'];
        Name = json['Name'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'AddressTypeID': AddressTypeID,
        'AddressContact': AddressContact,
        'AttentionTo': AttentionTo,
        'AddressLine1': AddressLine1,
        'AddressLine2': AddressLine2,
        'AddressLine3': AddressLine3,
        'AddressCity': AddressCity,
        'AddressState': AddressState,
        'AddressZip': AddressZip,
        'AddressCountry': AddressCountry,
        'PhoneNumber': PhoneNumber,
        'FaxNumber': FaxNumber,
        'UID': UID,
        'Name': Name
    };

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

class OrderHeader implements IConvertible
{
    int? ID;
    int? AgentID;
    int? CustomerID;
    String? AgentName;
    String? CustomerName;
    DateTime? OrderDate;
    int? OrderStatus;
    String? OrderStatusText;
    int? TotalQuantityUnits;
    double? TotalOrderCost;
    double? TotalProductCost;
    double? TotalOrderTax;
    double? TotalShippingCost;
    int? BillingAddressID;
    int? ShippingAddressID;
    double? CustomerPaidAmount;
    String? Notes;
    String? UID;
    bool? Recalculate;
    String? PublicOrderID;
    String? Address;
    Address? ShippingAddress;
    Address? BillingAddress;
    bool? isMultiShip;

    OrderHeader({this.ID,this.AgentID,this.CustomerID,this.AgentName,this.CustomerName,this.OrderDate,this.OrderStatus,this.OrderStatusText,this.TotalQuantityUnits,this.TotalOrderCost,this.TotalProductCost,this.TotalOrderTax,this.TotalShippingCost,this.BillingAddressID,this.ShippingAddressID,this.CustomerPaidAmount,this.Notes,this.UID,this.Recalculate,this.PublicOrderID,this.Address,this.ShippingAddress,this.BillingAddress,this.isMultiShip});
    OrderHeader.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        AgentID = json['AgentID'];
        CustomerID = json['CustomerID'];
        AgentName = json['AgentName'];
        CustomerName = json['CustomerName'];
        OrderDate = JsonConverters.fromJson(json['OrderDate'],'DateTime',context!);
        OrderStatus = json['OrderStatus'];
        OrderStatusText = json['OrderStatusText'];
        TotalQuantityUnits = json['TotalQuantityUnits'];
        TotalOrderCost = JsonConverters.toDouble(json['TotalOrderCost']);
        TotalProductCost = JsonConverters.toDouble(json['TotalProductCost']);
        TotalOrderTax = JsonConverters.toDouble(json['TotalOrderTax']);
        TotalShippingCost = JsonConverters.toDouble(json['TotalShippingCost']);
        BillingAddressID = json['BillingAddressID'];
        ShippingAddressID = json['ShippingAddressID'];
        CustomerPaidAmount = JsonConverters.toDouble(json['CustomerPaidAmount']);
        Notes = json['Notes'];
        UID = json['UID'];
        Recalculate = json['Recalculate'];
        PublicOrderID = json['PublicOrderID'];
        Address = json['Address'];
        ShippingAddress = JsonConverters.fromJson(json['ShippingAddress'],'Address',context!);
        BillingAddress = JsonConverters.fromJson(json['BillingAddress'],'Address',context!);
        isMultiShip = json['isMultiShip'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'AgentID': AgentID,
        'CustomerID': CustomerID,
        'AgentName': AgentName,
        'CustomerName': CustomerName,
        'OrderDate': JsonConverters.toJson(OrderDate,'DateTime',context!),
        'OrderStatus': OrderStatus,
        'OrderStatusText': OrderStatusText,
        'TotalQuantityUnits': TotalQuantityUnits,
        'TotalOrderCost': TotalOrderCost,
        'TotalProductCost': TotalProductCost,
        'TotalOrderTax': TotalOrderTax,
        'TotalShippingCost': TotalShippingCost,
        'BillingAddressID': BillingAddressID,
        'ShippingAddressID': ShippingAddressID,
        'CustomerPaidAmount': CustomerPaidAmount,
        'Notes': Notes,
        'UID': UID,
        'Recalculate': Recalculate,
        'PublicOrderID': PublicOrderID,
        'Address': Address,
        'ShippingAddress': JsonConverters.toJson(ShippingAddress,'Address',context!),
        'BillingAddress': JsonConverters.toJson(BillingAddress,'Address',context!),
        'isMultiShip': isMultiShip
    };

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

class OrderHeadersResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<OrderHeader>? OrderHeaders = [];

    OrderHeadersResponse({this.ResponseStatus,this.OrderHeaders});
    OrderHeadersResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        OrderHeaders = JsonConverters.fromJson(json['OrderHeaders'],'List<OrderHeader>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'OrderHeaders': JsonConverters.toJson(OrderHeaders,'List<OrderHeader>',context!)
    };

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

class OrderHeadersRequest implements IConvertible
{
    String? AgentID;
    List<OrderHeader>? OrderHeaders = [];

    OrderHeadersRequest({this.AgentID,this.OrderHeaders});
    OrderHeadersRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AgentID = json['AgentID'];
        OrderHeaders = JsonConverters.fromJson(json['OrderHeaders'],'List<OrderHeader>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AgentID': AgentID,
        'OrderHeaders': JsonConverters.toJson(OrderHeaders,'List<OrderHeader>',context!)
    };

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'Address': TypeInfo(TypeOf.Class, create:() => Address()),
    'OrderHeader': TypeInfo(TypeOf.Class, create:() => OrderHeader()),
    'OrderHeadersResponse': TypeInfo(TypeOf.Class, create:() => OrderHeadersResponse()),
    'List<OrderHeader>': TypeInfo(TypeOf.Class, create:() => <OrderHeader>[]),
    'OrderHeadersRequest': TypeInfo(TypeOf.Class, create:() => OrderHeadersRequest()),
});

Dart OrderHeadersRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/OrderHeaders HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<OrderHeadersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentID>00000000-0000-0000-0000-000000000000</AgentID>
  <OrderHeaders>
    <OrderHeader>
      <Address>String</Address>
      <AgentID>0</AgentID>
      <AgentName>String</AgentName>
      <BillingAddress>
        <AddressCity>String</AddressCity>
        <AddressContact>String</AddressContact>
        <AddressCountry>String</AddressCountry>
        <AddressLine1>String</AddressLine1>
        <AddressLine2>String</AddressLine2>
        <AddressLine3>String</AddressLine3>
        <AddressState>String</AddressState>
        <AddressTypeID>0</AddressTypeID>
        <AddressZip>String</AddressZip>
        <AttentionTo>String</AttentionTo>
        <FaxNumber>String</FaxNumber>
        <ID>0</ID>
        <Name>String</Name>
        <PhoneNumber>String</PhoneNumber>
        <UID>00000000-0000-0000-0000-000000000000</UID>
      </BillingAddress>
      <BillingAddressID>0</BillingAddressID>
      <CustomerID>0</CustomerID>
      <CustomerName>String</CustomerName>
      <CustomerPaidAmount>0</CustomerPaidAmount>
      <ID>0</ID>
      <Notes>String</Notes>
      <OrderDate>0001-01-01T00:00:00</OrderDate>
      <OrderStatus>0</OrderStatus>
      <OrderStatusText>String</OrderStatusText>
      <PublicOrderID>String</PublicOrderID>
      <Recalculate>false</Recalculate>
      <ShippingAddress>
        <AddressCity>String</AddressCity>
        <AddressContact>String</AddressContact>
        <AddressCountry>String</AddressCountry>
        <AddressLine1>String</AddressLine1>
        <AddressLine2>String</AddressLine2>
        <AddressLine3>String</AddressLine3>
        <AddressState>String</AddressState>
        <AddressTypeID>0</AddressTypeID>
        <AddressZip>String</AddressZip>
        <AttentionTo>String</AttentionTo>
        <FaxNumber>String</FaxNumber>
        <ID>0</ID>
        <Name>String</Name>
        <PhoneNumber>String</PhoneNumber>
        <UID>00000000-0000-0000-0000-000000000000</UID>
      </ShippingAddress>
      <ShippingAddressID>0</ShippingAddressID>
      <TotalOrderCost>0</TotalOrderCost>
      <TotalOrderTax>0</TotalOrderTax>
      <TotalProductCost>0</TotalProductCost>
      <TotalQuantityUnits>0</TotalQuantityUnits>
      <TotalShippingCost>0</TotalShippingCost>
      <UID>00000000-0000-0000-0000-000000000000</UID>
      <isMultiShip>false</isMultiShip>
    </OrderHeader>
  </OrderHeaders>
</OrderHeadersRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OrderHeadersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <OrderHeaders>
    <OrderHeader>
      <Address>String</Address>
      <AgentID>0</AgentID>
      <AgentName>String</AgentName>
      <BillingAddress>
        <AddressCity>String</AddressCity>
        <AddressContact>String</AddressContact>
        <AddressCountry>String</AddressCountry>
        <AddressLine1>String</AddressLine1>
        <AddressLine2>String</AddressLine2>
        <AddressLine3>String</AddressLine3>
        <AddressState>String</AddressState>
        <AddressTypeID>0</AddressTypeID>
        <AddressZip>String</AddressZip>
        <AttentionTo>String</AttentionTo>
        <FaxNumber>String</FaxNumber>
        <ID>0</ID>
        <Name>String</Name>
        <PhoneNumber>String</PhoneNumber>
        <UID>00000000-0000-0000-0000-000000000000</UID>
      </BillingAddress>
      <BillingAddressID>0</BillingAddressID>
      <CustomerID>0</CustomerID>
      <CustomerName>String</CustomerName>
      <CustomerPaidAmount>0</CustomerPaidAmount>
      <ID>0</ID>
      <Notes>String</Notes>
      <OrderDate>0001-01-01T00:00:00</OrderDate>
      <OrderStatus>0</OrderStatus>
      <OrderStatusText>String</OrderStatusText>
      <PublicOrderID>String</PublicOrderID>
      <Recalculate>false</Recalculate>
      <ShippingAddress>
        <AddressCity>String</AddressCity>
        <AddressContact>String</AddressContact>
        <AddressCountry>String</AddressCountry>
        <AddressLine1>String</AddressLine1>
        <AddressLine2>String</AddressLine2>
        <AddressLine3>String</AddressLine3>
        <AddressState>String</AddressState>
        <AddressTypeID>0</AddressTypeID>
        <AddressZip>String</AddressZip>
        <AttentionTo>String</AttentionTo>
        <FaxNumber>String</FaxNumber>
        <ID>0</ID>
        <Name>String</Name>
        <PhoneNumber>String</PhoneNumber>
        <UID>00000000-0000-0000-0000-000000000000</UID>
      </ShippingAddress>
      <ShippingAddressID>0</ShippingAddressID>
      <TotalOrderCost>0</TotalOrderCost>
      <TotalOrderTax>0</TotalOrderTax>
      <TotalProductCost>0</TotalProductCost>
      <TotalQuantityUnits>0</TotalQuantityUnits>
      <TotalShippingCost>0</TotalShippingCost>
      <UID>00000000-0000-0000-0000-000000000000</UID>
      <isMultiShip>false</isMultiShip>
    </OrderHeader>
  </OrderHeaders>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</OrderHeadersResponse>