Trendsic Platform Service

<back to all web services

ClosedOrderRequest

The following routes are available for this service:
GET/v1/OrderHeaders/Closed
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class Address
            Public Overridable Property ID As Integer
            Public Overridable Property AddressTypeID As Byte
            Public Overridable Property AddressContact As String
            Public Overridable Property AttentionTo As String
            Public Overridable Property AddressLine1 As String
            Public Overridable Property AddressLine2 As String
            Public Overridable Property AddressLine3 As String
            Public Overridable Property AddressCity As String
            Public Overridable Property AddressState As String
            Public Overridable Property AddressZip As String
            Public Overridable Property AddressCountry As String
            Public Overridable Property PhoneNumber As String
            Public Overridable Property FaxNumber As String
            Public Overridable Property UID As Guid
            Public Overridable Property Name As String
        End Class

        Public Partial Class ClosedOrderRequest
        End Class

        Public Partial Class OrderHeader
            Public Overridable Property ID As Integer
            Public Overridable Property AgentID As Integer
            Public Overridable Property CustomerID As Integer
            Public Overridable Property AgentName As String
            Public Overridable Property CustomerName As String
            Public Overridable Property OrderDate As Date
            Public Overridable Property OrderStatus As Byte
            Public Overridable Property OrderStatusText As String
            Public Overridable Property TotalQuantityUnits As Short
            Public Overridable Property TotalOrderCost As Decimal
            Public Overridable Property TotalProductCost As Decimal
            Public Overridable Property TotalOrderTax As Decimal
            Public Overridable Property TotalShippingCost As Decimal
            Public Overridable Property BillingAddressID As Integer
            Public Overridable Property ShippingAddressID As Integer
            Public Overridable Property CustomerPaidAmount As Decimal
            Public Overridable Property Notes As String
            Public Overridable Property UID As Guid
            Public Overridable Property Recalculate As Boolean
            Public Overridable Property PublicOrderID As String
            Public Overridable Property Address As String
            Public Overridable Property ShippingAddress As Address
            Public Overridable Property BillingAddress As Address
            Public Overridable Property isMultiShip As Boolean
        End Class

        Public Partial Class OrderHeadersResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property OrderHeaders As List(Of OrderHeader) = New List(Of OrderHeader)
        End Class
    End Namespace
End Namespace

VB.NET ClosedOrderRequest DTOs

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

HTTP + JSV

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

GET /v1/OrderHeaders/Closed HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	OrderHeaders: 
	[
		{
			ID: 0,
			AgentID: 0,
			CustomerID: 0,
			AgentName: String,
			CustomerName: String,
			OrderDate: 0001-01-01,
			OrderStatus: 0,
			OrderStatusText: String,
			TotalQuantityUnits: 0,
			TotalOrderCost: 0,
			TotalProductCost: 0,
			TotalOrderTax: 0,
			TotalShippingCost: 0,
			BillingAddressID: 0,
			ShippingAddressID: 0,
			CustomerPaidAmount: 0,
			Notes: String,
			UID: 00000000000000000000000000000000,
			Recalculate: False,
			PublicOrderID: String,
			Address: String,
			ShippingAddress: 
			{
				ID: 0,
				AddressTypeID: 0,
				AddressContact: String,
				AttentionTo: String,
				AddressLine1: String,
				AddressLine2: String,
				AddressLine3: String,
				AddressCity: String,
				AddressState: String,
				AddressZip: String,
				AddressCountry: String,
				PhoneNumber: String,
				FaxNumber: String,
				UID: 00000000000000000000000000000000,
				Name: String
			},
			BillingAddress: 
			{
				ID: 0,
				AddressTypeID: 0,
				AddressContact: String,
				AttentionTo: String,
				AddressLine1: String,
				AddressLine2: String,
				AddressLine3: String,
				AddressCity: String,
				AddressState: String,
				AddressZip: String,
				AddressCountry: String,
				PhoneNumber: String,
				FaxNumber: String,
				UID: 00000000000000000000000000000000,
				Name: String
			},
			isMultiShip: False
		}
	]
}