Trendsic Platform Service

<back to all web services

CourierDriverStopsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/worker/dispatch/od/stops
CourierDriverStopsResponse Parameters:
NameParameterData TypeRequiredDescription
RowsformList<CourierStopRow>No
HiddenformboolNo
FactsformCourierPingFactsNo
AvailableformboolNo
ServerUtcformDateTimeNo
ResponseStatusformResponseStatusNo
CourierStopRow Parameters:
NameParameterData TypeRequiredDescription
KindformstringNo
AtUtcformDateTimeNo
OrderCodeformstringNo
UnitsformintNo
OrderCountformint?No
RunCodeformstringNo
StopSeqformint?No
StreetformstringNo
CityformstringNo
ZipformstringNo
FacilityNameformstringNo
ReasonformstringNo
CourierPingFacts Parameters:
NameParameterData TypeRequiredDescription
BusyformboolNo
RadiusMiformdecimal?No
HideAddressesInHistoryformboolNo
PingRadiusMiformdecimal?No
PingRadiusUntilUtcformDateTime?No
UnitOneformstringNo
UnitManyformstringNo
UnitOneEsformstringNo
UnitManyEsformstringNo
FacilityNounformstringNo
FacilityNounEsformstringNo

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

{
	Rows: 
	[
		{
			Kind: String,
			AtUtc: 0001-01-01,
			OrderCode: String,
			Units: 0,
			OrderCount: 0,
			RunCode: String,
			StopSeq: 0,
			Street: String,
			City: String,
			Zip: String,
			FacilityName: String,
			Reason: String
		}
	],
	Hidden: False,
	Facts: 
	{
		Busy: False,
		RadiusMi: 0,
		HideAddressesInHistory: False,
		PingRadiusMi: 0,
		PingRadiusUntilUtc: 0001-01-01,
		UnitOne: String,
		UnitMany: String,
		UnitOneEs: String,
		UnitManyEs: String,
		FacilityNoun: String,
		FacilityNounEs: String
	},
	Available: False,
	ServerUtc: 0001-01-01,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}