Trendsic Platform Service

<back to all web services

DispatchRequestCreateRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/requests
import Foundation
import ServiceStack

public class DispatchRequestCreateRequest : Codable
{
    public var customerName:String
    public var customerPhone:String
    public var customerEmail:String
    public var cargo:String
    public var units:Int
    public var fromLoc:String
    public var toLoc:String
    public var miles:Int?
    public var windowText:String
    public var isUrgent:Bool
    public var notes:String

    required public init(){}
}

public class DispatchRequestsResponse : Codable
{
    public var requests:[DispatchRequestView] = []
    public var request:DispatchRequestView
    public var rigCounts:[DispatchRigCountView] = []
    public var carriers:[DispatchCarrierPickView] = []
    public var quoteLink:String
    public var delivery:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class DispatchRequestView : Codable
{
    public var requestId:Int
    public var code:String
    public var customerName:String
    public var customerPhone:String
    public var customerEmail:String
    public var cargo:String
    public var units:Int
    public var fromLoc:String
    public var toLoc:String
    public var miles:Int?
    public var windowText:String
    public var isUrgent:Bool
    public var notes:String
    public var source:String
    public var status:String
    public var requiredRig:String
    public var unitsPerTruck:Int?
    public var ratePerLoad:Double?
    public var urgencyPct:Double
    public var costPerLoad:Double?
    public var loadsNeeded:Int?
    public var quoteTotal:Double?
    public var quoteVersion:Int
    public var quotedUtc:Date?
    public var quotedBy:String
    public var acceptTokenExpiresUtc:Date?
    public var acceptedUtc:Date?
    public var acceptedVia:String
    public var declinedUtc:Date?
    public var declinedBy:String
    public var declineReason:String
    public var jobsCreated:Int
    public var jobsDone:Int
    public var jobsNeedDriver:Int
    public var createdUtc:Date
    public var createdBy:String
    public var events:[DispatchRequestEventView] = []

    required public init(){}
}

public class DispatchRequestEventView : Codable
{
    public var eventId:Int
    public var kind:String
    public var detail:String
    public var atUtc:Date
    public var byWho:String

    required public init(){}
}

public class DispatchRigCountView : Codable
{
    public var rigType:String
    public var rigs:Int

    required public init(){}
}

public class DispatchCarrierPickView : Codable
{
    public var vendorID:Int
    public var vendorName:String

    required public init(){}
}


Swift DispatchRequestCreateRequest 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.

POST /v1/dispatch/requests HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CustomerName: String,
	CustomerPhone: String,
	CustomerEmail: String,
	Cargo: String,
	Units: 0,
	FromLoc: String,
	ToLoc: String,
	Miles: 0,
	WindowText: String,
	IsUrgent: False,
	Notes: String
}
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
		}
	}
}