Trendsic Platform Service

<back to all web services

DispatchLoadsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dispatch/loads
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DispatchLoadStageView() = 
        member val Stage:String = null with get,set
        member val AtUtc:DateTime = new DateTime() with get,set
        member val Note:String = null with get,set

    [<AllowNullLiteral>]
    type DispatchLoadView() = 
        member val LoadId:Int32 = new Int32() with get,set
        member val Code:String = null with get,set
        member val Module:String = null with get,set
        member val TruckLabel:String = null with get,set
        member val DriverLabel:String = null with get,set
        member val CarrierLabel:String = null with get,set
        member val SourceLabel:String = null with get,set
        member val DestinationLabel:String = null with get,set
        member val Qty:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Unit:String = null with get,set
        member val QtyText:String = null with get,set
        member val TicketCode:String = null with get,set
        member val RateApplied:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val RateBasis:String = null with get,set
        member val Revenue:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val PayPlanLabel:String = null with get,set
        member val Pay:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Status:String = null with get,set
        member val OpenedUtc:DateTime = new DateTime() with get,set
        member val ClosedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Photos:Int32 = new Int32() with get,set
        member val Stages:ResizeArray<DispatchLoadStageView> = new ResizeArray<DispatchLoadStageView>() with get,set

    [<AllowNullLiteral>]
    type DispatchLoadsResponse() = 
        member val Loads:ResizeArray<DispatchLoadView> = new ResizeArray<DispatchLoadView>() with get,set
        member val Hours:Int32 = new Int32() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type DispatchLoadsRequest() = 
        member val Hours:Int32 = new Int32() with get,set
        member val Module:String = null with get,set

F# DispatchLoadsRequest 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/dispatch/loads HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Loads: 
	[
		{
			LoadId: 0,
			Code: String,
			Module: String,
			TruckLabel: String,
			DriverLabel: String,
			CarrierLabel: String,
			SourceLabel: String,
			DestinationLabel: String,
			Qty: 0,
			Unit: String,
			QtyText: String,
			TicketCode: String,
			RateApplied: 0,
			RateBasis: String,
			Revenue: 0,
			PayPlanLabel: String,
			Pay: 0,
			Status: String,
			OpenedUtc: 0001-01-01,
			ClosedUtc: 0001-01-01,
			Photos: 0,
			Stages: 
			[
				{
					Stage: String,
					AtUtc: 0001-01-01,
					Note: String
				}
			]
		}
	],
	Hours: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}