Trendsic Platform Service

DispatchRequestRequest

The following routes are available for this service:
GET,OPTIONS	/v1/dispatch/requests/{RequestId}


export class DispatchRequestEventView
{
    public EventId: number;
    public Kind: string;
    public Detail: string;
    public AtUtc: string;
    public ByWho: string;

    public constructor(init?: Partial<DispatchRequestEventView>) { (Object as any).assign(this, init); }
}

export class DispatchRequestView
{
    public RequestId: number;
    public Code: string;
    public CustomerName: string;
    public CustomerPhone: string;
    public CustomerEmail: string;
    public Cargo: string;
    public Units: number;
    public FromLoc: string;
    public ToLoc: string;
    public Miles?: number;
    public WindowText: string;
    public IsUrgent: boolean;
    public Notes: string;
    public Source: string;
    public Status: string;
    public RequiredRig: string;
    public UnitsPerTruck?: number;
    public RatePerLoad?: number;
    public UrgencyPct: number;
    public CostPerLoad?: number;
    public LoadsNeeded?: number;
    public QuoteTotal?: number;
    public QuoteVersion: number;
    public QuotedUtc?: string;
    public QuotedBy: string;
    public AcceptTokenExpiresUtc?: string;
    public AcceptedUtc?: string;
    public AcceptedVia: string;
    public DeclinedUtc?: string;
    public DeclinedBy: string;
    public DeclineReason: string;
    public JobsCreated: number;
    public JobsDone: number;
    public JobsNeedDriver: number;
    public CreatedUtc: string;
    public CreatedBy: string;
    public Events: DispatchRequestEventView[] = [];

    public constructor(init?: Partial<DispatchRequestView>) { (Object as any).assign(this, init); }
}

export class DispatchRigCountView
{
    public RigType: string;
    public Rigs: number;

    public constructor(init?: Partial<DispatchRigCountView>) { (Object as any).assign(this, init); }
}

export class DispatchCarrierPickView
{
    public VendorID: number;
    public VendorName: string;

    public constructor(init?: Partial<DispatchCarrierPickView>) { (Object as any).assign(this, init); }
}

export class DispatchRequestsResponse
{
    public Requests: DispatchRequestView[] = [];
    public Request: DispatchRequestView;
    public RigCounts: DispatchRigCountView[] = [];
    public Carriers: DispatchCarrierPickView[] = [];
    public QuoteLink: string;
    public Delivery: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<DispatchRequestsResponse>) { (Object as any).assign(this, init); }
}

export class DispatchRequestRequest
{
    public RequestId: number;

    public constructor(init?: Partial<DispatchRequestRequest>) { (Object as any).assign(this, init); }
}

TypeScript DispatchRequestRequest 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/requests/{RequestId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Requests: 
	[
		{
			RequestId: 0,
			Code: String,
			CustomerName: String,
			CustomerPhone: String,
			CustomerEmail: String,
			Cargo: String,
			Units: 0,
			FromLoc: String,
			ToLoc: String,
			Miles: 0,
			WindowText: String,
			IsUrgent: False,
			Notes: String,
			Source: String,
			Status: String,
			RequiredRig: String,
			UnitsPerTruck: 0,
			RatePerLoad: 0,
			UrgencyPct: 0,
			CostPerLoad: 0,
			LoadsNeeded: 0,
			QuoteTotal: 0,
			QuoteVersion: 0,
			QuotedUtc: 0001-01-01,
			QuotedBy: String,
			AcceptTokenExpiresUtc: 0001-01-01,
			AcceptedUtc: 0001-01-01,
			AcceptedVia: String,
			DeclinedUtc: 0001-01-01,
			DeclinedBy: String,
			DeclineReason: String,
			JobsCreated: 0,
			JobsDone: 0,
			JobsNeedDriver: 0,
			CreatedUtc: 0001-01-01,
			CreatedBy: String,
			Events: 
			[
				{
					EventId: 0,
					Kind: String,
					Detail: String,
					AtUtc: 0001-01-01,
					ByWho: String
				}
			]
		}
	],
	Request: 
	{
		RequestId: 0,
		Code: String,
		CustomerName: String,
		CustomerPhone: String,
		CustomerEmail: String,
		Cargo: String,
		Units: 0,
		FromLoc: String,
		ToLoc: String,
		Miles: 0,
		WindowText: String,
		IsUrgent: False,
		Notes: String,
		Source: String,
		Status: String,
		RequiredRig: String,
		UnitsPerTruck: 0,
		RatePerLoad: 0,
		UrgencyPct: 0,
		CostPerLoad: 0,
		LoadsNeeded: 0,
		QuoteTotal: 0,
		QuoteVersion: 0,
		QuotedUtc: 0001-01-01,
		QuotedBy: String,
		AcceptTokenExpiresUtc: 0001-01-01,
		AcceptedUtc: 0001-01-01,
		AcceptedVia: String,
		DeclinedUtc: 0001-01-01,
		DeclinedBy: String,
		DeclineReason: String,
		JobsCreated: 0,
		JobsDone: 0,
		JobsNeedDriver: 0,
		CreatedUtc: 0001-01-01,
		CreatedBy: String,
		Events: 
		[
			{
				EventId: 0,
				Kind: String,
				Detail: String,
				AtUtc: 0001-01-01,
				ByWho: String
			}
		]
	},
	RigCounts: 
	[
		{
			RigType: String,
			Rigs: 0
		}
	],
	Carriers: 
	[
		{
			VendorID: 0,
			VendorName: String
		}
	],
	QuoteLink: String,
	Delivery: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}