Trendsic Platform Service

<back to all web services

FleetLiveRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/fleet/live
FleetLiveRequest Parameters:
NameParameterData TypeRequiredDescription
DatequerystringNo
StatusquerystringNo
CrewIDqueryint?No
ZipquerystringNo
BranchIdqueryGuid?No
SearchquerystringNo
PagequeryintNo
PageSizequeryintNo
FleetLiveResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
RowsformList<FleetRowDto>No
ActiveWorkersformintNo
EnRouteformintNo
OnSiteformintNo
WaitingformintNo
DoneformintNo
RunningLateformintNo
PageTotalformintNo
PageformintNo
PageSizeformintNo
FleetRowDto Parameters:
NameParameterData TypeRequiredDescription
ContactIDformintNo
WorkerNameformstringNo
CrewIDformint?No
CrewNameformstringNo
BranchIdformGuid?No
LiveStatusformstringNo
WorkerScheduleItemIDformint?No
JobIDformint?No
CurPropertyformstringNo
CurAddressformstringNo
CurZipformstringNo
EnRouteAtformstringNo
StartedAtformstringNo
LastLatformdecimal?No
LastLngformdecimal?No
LastLocAtformstringNo
NextPropertyformstringNo
DoneVisitsformintNo
TotalVisitsformintNo

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

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Rows: 
	[
		{
			ContactID: 0,
			WorkerName: String,
			CrewID: 0,
			CrewName: String,
			BranchId: 00000000000000000000000000000000,
			LiveStatus: String,
			WorkerScheduleItemID: 0,
			JobID: 0,
			CurProperty: String,
			CurAddress: String,
			CurZip: String,
			EnRouteAt: String,
			StartedAt: String,
			LastLat: 0,
			LastLng: 0,
			LastLocAt: String,
			NextProperty: String,
			DoneVisits: 0,
			TotalVisits: 0
		}
	],
	ActiveWorkers: 0,
	EnRoute: 0,
	OnSite: 0,
	Waiting: 0,
	Done: 0,
	RunningLate: 0,
	PageTotal: 0,
	Page: 0,
	PageSize: 0
}