| GET,OPTIONS | /v1/fleet/live |
|---|
"use strict";
export class FleetRowDto {
/** @param {{ContactID?:number,WorkerName?:string,CrewID?:number,CrewName?:string,BranchId?:string,LiveStatus?:string,WorkerScheduleItemID?:number,JobID?:number,CurProperty?:string,CurAddress?:string,CurZip?:string,EnRouteAt?:string,StartedAt?:string,LastLat?:number,LastLng?:number,LastLocAt?:string,NextProperty?:string,DoneVisits?:number,TotalVisits?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ContactID;
/** @type {string} */
WorkerName;
/** @type {?number} */
CrewID;
/** @type {string} */
CrewName;
/** @type {?string} */
BranchId;
/** @type {string} */
LiveStatus;
/** @type {?number} */
WorkerScheduleItemID;
/** @type {?number} */
JobID;
/** @type {string} */
CurProperty;
/** @type {string} */
CurAddress;
/** @type {string} */
CurZip;
/** @type {string} */
EnRouteAt;
/** @type {string} */
StartedAt;
/** @type {?number} */
LastLat;
/** @type {?number} */
LastLng;
/** @type {string} */
LastLocAt;
/** @type {string} */
NextProperty;
/** @type {number} */
DoneVisits;
/** @type {number} */
TotalVisits;
}
export class FleetLiveResponse {
/** @param {{ResponseStatus?:ResponseStatus,Rows?:FleetRowDto[],ActiveWorkers?:number,EnRoute?:number,OnSite?:number,Waiting?:number,Done?:number,RunningLate?:number,PageTotal?:number,Page?:number,PageSize?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {FleetRowDto[]} */
Rows = [];
/** @type {number} */
ActiveWorkers;
/** @type {number} */
EnRoute;
/** @type {number} */
OnSite;
/** @type {number} */
Waiting;
/** @type {number} */
Done;
/** @type {number} */
RunningLate;
/** @type {number} */
PageTotal;
/** @type {number} */
Page;
/** @type {number} */
PageSize;
}
export class FleetLiveRequest {
/** @param {{Date?:string,Status?:string,CrewID?:number,Zip?:string,BranchId?:string,Search?:string,Page?:number,PageSize?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Date;
/** @type {string} */
Status;
/** @type {?number} */
CrewID;
/** @type {string} */
Zip;
/** @type {?string} */
BranchId;
/** @type {string} */
Search;
/** @type {number} */
Page;
/** @type {number} */
PageSize;
}
JavaScript FleetLiveRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FleetLiveResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ActiveWorkers>0</ActiveWorkers>
<Done>0</Done>
<EnRoute>0</EnRoute>
<OnSite>0</OnSite>
<Page>0</Page>
<PageSize>0</PageSize>
<PageTotal>0</PageTotal>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Rows>
<FleetRowDto>
<BranchId>00000000-0000-0000-0000-000000000000</BranchId>
<ContactID>0</ContactID>
<CrewID>0</CrewID>
<CrewName>String</CrewName>
<CurAddress>String</CurAddress>
<CurProperty>String</CurProperty>
<CurZip>String</CurZip>
<DoneVisits>0</DoneVisits>
<EnRouteAt>String</EnRouteAt>
<JobID>0</JobID>
<LastLat>0</LastLat>
<LastLng>0</LastLng>
<LastLocAt>String</LastLocAt>
<LiveStatus>String</LiveStatus>
<NextProperty>String</NextProperty>
<StartedAt>String</StartedAt>
<TotalVisits>0</TotalVisits>
<WorkerName>String</WorkerName>
<WorkerScheduleItemID>0</WorkerScheduleItemID>
</FleetRowDto>
</Rows>
<RunningLate>0</RunningLate>
<Waiting>0</Waiting>
</FleetLiveResponse>