Trendsic Platform Service

<back to all web services

FleetLiveRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/fleet/live

export class FleetRowDto
{
    public ContactID: number;
    public WorkerName: string;
    public CrewID?: number;
    public CrewName: string;
    public BranchId?: string;
    public LiveStatus: string;
    public WorkerScheduleItemID?: number;
    public JobID?: number;
    public CurProperty: string;
    public CurAddress: string;
    public CurZip: string;
    public EnRouteAt: string;
    public StartedAt: string;
    public LastLat?: number;
    public LastLng?: number;
    public LastLocAt: string;
    public NextProperty: string;
    public DoneVisits: number;
    public TotalVisits: number;

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

export class FleetLiveResponse
{
    public ResponseStatus: ResponseStatus;
    public Rows: FleetRowDto[] = [];
    public ActiveWorkers: number;
    public EnRoute: number;
    public OnSite: number;
    public Waiting: number;
    public Done: number;
    public RunningLate: number;
    public PageTotal: number;
    public Page: number;
    public PageSize: number;

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

export class FleetLiveRequest
{
    public Date: string;
    public Status: string;
    public CrewID?: number;
    public Zip: string;
    public BranchId?: string;
    public Search: string;
    public Page: number;
    public PageSize: number;

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

TypeScript FleetLiveRequest 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/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
}