Trendsic Platform Service

<back to all web services

DispatchRequestAcceptRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/requests/{RequestId}/accept
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class DispatchRequestAcceptRequest
{
    open var RequestId:Int? = null
}

open class DispatchRequestsResponse
{
    open var Requests:ArrayList<DispatchRequestView> = ArrayList<DispatchRequestView>()
    open var Request:DispatchRequestView? = null
    open var RigCounts:ArrayList<DispatchRigCountView> = ArrayList<DispatchRigCountView>()
    open var Carriers:ArrayList<DispatchCarrierPickView> = ArrayList<DispatchCarrierPickView>()
    open var QuoteLink:String? = null
    open var Delivery:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class DispatchRequestView
{
    open var RequestId:Int? = null
    open var Code:String? = null
    open var CustomerName:String? = null
    open var CustomerPhone:String? = null
    open var CustomerEmail:String? = null
    open var Cargo:String? = null
    open var Units:Int? = null
    open var FromLoc:String? = null
    open var ToLoc:String? = null
    open var Miles:Int? = null
    open var WindowText:String? = null
    open var IsUrgent:Boolean? = null
    open var Notes:String? = null
    open var Source:String? = null
    open var Status:String? = null
    open var RequiredRig:String? = null
    open var UnitsPerTruck:Int? = null
    open var RatePerLoad:BigDecimal? = null
    open var UrgencyPct:BigDecimal? = null
    open var CostPerLoad:BigDecimal? = null
    open var LoadsNeeded:Int? = null
    open var QuoteTotal:BigDecimal? = null
    open var QuoteVersion:Int? = null
    open var QuotedUtc:Date? = null
    open var QuotedBy:String? = null
    open var AcceptTokenExpiresUtc:Date? = null
    open var AcceptedUtc:Date? = null
    open var AcceptedVia:String? = null
    open var DeclinedUtc:Date? = null
    open var DeclinedBy:String? = null
    open var DeclineReason:String? = null
    open var JobsCreated:Int? = null
    open var JobsDone:Int? = null
    open var JobsNeedDriver:Int? = null
    open var CreatedUtc:Date? = null
    open var CreatedBy:String? = null
    open var Events:ArrayList<DispatchRequestEventView> = ArrayList<DispatchRequestEventView>()
}

open class DispatchRequestEventView
{
    open var EventId:Int? = null
    open var Kind:String? = null
    open var Detail:String? = null
    open var AtUtc:Date? = null
    open var ByWho:String? = null
}

open class DispatchRigCountView
{
    open var RigType:String? = null
    open var Rigs:Int? = null
}

open class DispatchCarrierPickView
{
    open var VendorID:Int? = null
    open var VendorName:String? = null
}

Kotlin DispatchRequestAcceptRequest 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/{RequestId}/accept HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RequestId: 0
}
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
		}
	}
}