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 .xml suffix or ?format=xml

HTTP + 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>