Trendsic Platform Service

<back to all web services

FleetLiveRequest

Requires Authentication
The following routes are available for this service:
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 .other suffix or ?format=other

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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}