Trendsic Platform Service

<back to all web services

FleetLiveRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/fleet/live
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type FleetRowDto() = 
        member val ContactID:Int32 = new Int32() with get,set
        member val WorkerName:String = null with get,set
        member val CrewID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CrewName:String = null with get,set
        member val BranchId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val LiveStatus:String = null with get,set
        member val WorkerScheduleItemID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val JobID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CurProperty:String = null with get,set
        member val CurAddress:String = null with get,set
        member val CurZip:String = null with get,set
        member val EnRouteAt:String = null with get,set
        member val StartedAt:String = null with get,set
        member val LastLat:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val LastLng:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val LastLocAt:String = null with get,set
        member val NextProperty:String = null with get,set
        member val DoneVisits:Int32 = new Int32() with get,set
        member val TotalVisits:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type FleetLiveResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Rows:ResizeArray<FleetRowDto> = new ResizeArray<FleetRowDto>() with get,set
        member val ActiveWorkers:Int32 = new Int32() with get,set
        member val EnRoute:Int32 = new Int32() with get,set
        member val OnSite:Int32 = new Int32() with get,set
        member val Waiting:Int32 = new Int32() with get,set
        member val Done:Int32 = new Int32() with get,set
        member val RunningLate:Int32 = new Int32() with get,set
        member val PageTotal:Int32 = new Int32() with get,set
        member val Page:Int32 = new Int32() with get,set
        member val PageSize:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type FleetLiveRequest() = 
        member val Date:String = null with get,set
        member val Status:String = null with get,set
        member val CrewID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Zip:String = null with get,set
        member val BranchId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Search:String = null with get,set
        member val Page:Int32 = new Int32() with get,set
        member val PageSize:Int32 = new Int32() with get,set

F# FleetLiveRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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