Trendsic Platform Service

DriverPingAdvanceRequest

The following routes are available for this service:
POST,OPTIONS	/v1/worker/dispatch/ping/{Code}/advance

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 DriverStampView() = 
        member val Stage:String = null with get,set
        member val AtUtc:DateTime = new DateTime() with get,set
        member val Note:String = null with get,set

    [<AllowNullLiteral>]
    type DriverTruckView() = 
        member val Code:String = null with get,set
        member val Stage:String = null with get,set
        member val StageSinceUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LoadsToday:Int32 = new Int32() with get,set
        member val NetToday:Decimal = new Decimal() with get,set
        member val EstLoad:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Slot:String = null with get,set
        member val SiteName:String = null with get,set
        member val SupplierName:String = null with get,set
        member val NextSiteName:String = null with get,set
        member val Facility:String = null with get,set
        member val FacilityShort:String = null with get,set
        member val Unit:String = null with get,set
        member val QueuePosition:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val HoldCode:String = null with get,set
        member val HoldReason:String = null with get,set
        member val HoldEndUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val OpenLoadId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val OpenLoadCode:String = null with get,set
        member val OpenLoadPhotos:Int32 = new Int32() with get,set
        member val Stamps:ResizeArray<DriverStampView> = new ResizeArray<DriverStampView>() with get,set

    [<AllowNullLiteral>]
    type DriverRigView() = 
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val RigType:String = null with get,set
        member val IsFree:Boolean = new Boolean() with get,set
        member val HoldCode:String = null with get,set
        member val HoldReason:String = null with get,set
        member val HoldEndUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type DriverJobView() = 
        member val Kind:String = null with get,set
        member val Code:String = null with get,set
        member val Cargo:String = null with get,set
        member val Customer:String = null with get,set
        member val CustomerPhone:String = null with get,set
        member val HoldContact:String = null with get,set
        member val HoldPhone:String = null with get,set
        member val FromLoc:String = null with get,set
        member val ToLoc:String = null with get,set
        member val Miles:Int32 = new Int32() with get,set
        member val WindowText:String = null with get,set
        member val Stage:String = null with get,set
        member val Rate:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val RequiredRig:String = null with get,set
        member val EtaText:String = null with get,set
        member val OfferExpiresUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val RequestId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LoadId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LoadCode:String = null with get,set
        member val LoadPay:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Photos:Int32 = new Int32() with get,set
        member val Stamps:ResizeArray<DriverStampView> = new ResizeArray<DriverStampView>() with get,set

    [<AllowNullLiteral>]
    type DriverOdView() = 
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val Zone:String = null with get,set
        member val Status:String = null with get,set
        member val Tier:String = null with get,set
        member val Capabilities:String = null with get,set
        member val PingCode:String = null with get,set
        member val PingAddress:String = null with get,set
        member val PingZone:String = null with get,set
        member val PingBags:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PingNeeds:String = null with get,set
        member val PingNote:String = null with get,set
        member val PingExpiresUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val RunCode:String = null with get,set
        member val RunAddress:String = null with get,set
        member val RunZone:String = null with get,set
        member val RunBags:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RunStage:String = null with get,set
        member val RunNeeds:String = null with get,set
        member val RunNote:String = null with get,set
        member val RunEta:String = null with get,set
        member val OdBase:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val OdPerBag:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val HoldCode:String = null with get,set
        member val HoldReason:String = null with get,set
        member val HoldEndUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type DispatchIncidentMessageView() = 
        member val MessageId:Int32 = new Int32() with get,set
        member val Who:String = null with get,set
        member val Role:String = null with get,set
        member val Msg:String = null with get,set
        member val AtUtc:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type DriverIncidentView() = 
        member val IncidentId:Int32 = new Int32() with get,set
        member val Code:String = null with get,set
        member val Kind:String = null with get,set
        member val KindDetail:String = null with get,set
        member val Status:String = null with get,set
        member val LoadCode:String = null with get,set
        member val TruckCode:String = null with get,set
        member val LocationText:String = null with get,set
        member val DriverPref:String = null with get,set
        member val TruckRecovery:String = null with get,set
        member val LoadRecovery:String = null with get,set
        member val TransloadTruckCode:String = null with get,set
        member val HoldCode:String = null with get,set
        member val OpenedUtc:DateTime = new DateTime() with get,set
        member val ResolvedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Messages:ResizeArray<DispatchIncidentMessageView> = new ResizeArray<DispatchIncidentMessageView>() with get,set

    [<AllowNullLiteral>]
    type DriverPayLineView() = 
        member val Code:String = null with get,set
        member val Module:String = null with get,set
        member val SourceLabel:String = null with get,set
        member val DestinationLabel:String = null with get,set
        member val QtyText:String = null with get,set
        member val Pay:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val PayPlanLabel:String = null with get,set
        member val Status:String = null with get,set
        member val ClosedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val OpenedUtc:DateTime = new DateTime() with get,set
        member val TicketCode:String = null with get,set

    [<AllowNullLiteral>]
    type DriverMeResponse() = 
        member val ContactId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Phone:String = null with get,set
        member val PayPlanName:String = null with get,set
        member val PayPlanBasis:String = null with get,set
        member val PayPlanRate:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Truck:DriverTruckView = null with get,set
        member val Rig:DriverRigView = null with get,set
        member val Jobs:ResizeArray<DriverJobView> = new ResizeArray<DriverJobView>() with get,set
        member val Od:DriverOdView = null with get,set
        member val Incidents:ResizeArray<DriverIncidentView> = new ResizeArray<DriverIncidentView>() with get,set
        member val Pay:ResizeArray<DriverPayLineView> = new ResizeArray<DriverPayLineView>() with get,set
        member val ServerUtc:DateTime = new DateTime() with get,set
        member val Message:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type DriverPingAdvanceRequest() = 
        member val Code:String = null with get,set

F# DriverPingAdvanceRequest 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.

POST /v1/worker/dispatch/ping/{Code}/advance HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DriverPingAdvanceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Code>String</Code>
</DriverPingAdvanceRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DriverMeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ContactId>0</ContactId>
  <Incidents>
    <DriverIncidentView>
      <Code>String</Code>
      <DriverPref>String</DriverPref>
      <HoldCode>String</HoldCode>
      <IncidentId>0</IncidentId>
      <Kind>String</Kind>
      <KindDetail>String</KindDetail>
      <LoadCode>String</LoadCode>
      <LoadRecovery>String</LoadRecovery>
      <LocationText>String</LocationText>
      <Messages>
        <DispatchIncidentMessageView>
          <AtUtc>0001-01-01T00:00:00</AtUtc>
          <MessageId>0</MessageId>
          <Msg>String</Msg>
          <Role>String</Role>
          <Who>String</Who>
        </DispatchIncidentMessageView>
      </Messages>
      <OpenedUtc>0001-01-01T00:00:00</OpenedUtc>
      <ResolvedUtc>0001-01-01T00:00:00</ResolvedUtc>
      <Status>String</Status>
      <TransloadTruckCode>String</TransloadTruckCode>
      <TruckCode>String</TruckCode>
      <TruckRecovery>String</TruckRecovery>
    </DriverIncidentView>
  </Incidents>
  <Jobs>
    <DriverJobView>
      <Cargo>String</Cargo>
      <Code>String</Code>
      <Customer>String</Customer>
      <CustomerPhone>String</CustomerPhone>
      <EtaText>String</EtaText>
      <FromLoc>String</FromLoc>
      <HoldContact>String</HoldContact>
      <HoldPhone>String</HoldPhone>
      <Kind>String</Kind>
      <LoadCode>String</LoadCode>
      <LoadId>0</LoadId>
      <LoadPay>0</LoadPay>
      <Miles>0</Miles>
      <OfferExpiresUtc>0001-01-01T00:00:00</OfferExpiresUtc>
      <Photos>0</Photos>
      <Rate>0</Rate>
      <RequestId>0</RequestId>
      <RequiredRig>String</RequiredRig>
      <Stage>String</Stage>
      <Stamps>
        <DriverStampView>
          <AtUtc>0001-01-01T00:00:00</AtUtc>
          <Note>String</Note>
          <Stage>String</Stage>
        </DriverStampView>
      </Stamps>
      <ToLoc>String</ToLoc>
      <WindowText>String</WindowText>
    </DriverJobView>
  </Jobs>
  <Message>String</Message>
  <Name>String</Name>
  <Od>
    <Capabilities>String</Capabilities>
    <Code>String</Code>
    <HoldCode>String</HoldCode>
    <HoldEndUtc>0001-01-01T00:00:00</HoldEndUtc>
    <HoldReason>String</HoldReason>
    <Name>String</Name>
    <OdBase>0</OdBase>
    <OdPerBag>0</OdPerBag>
    <PingAddress>String</PingAddress>
    <PingBags>0</PingBags>
    <PingCode>String</PingCode>
    <PingExpiresUtc>0001-01-01T00:00:00</PingExpiresUtc>
    <PingNeeds>String</PingNeeds>
    <PingNote>String</PingNote>
    <PingZone>String</PingZone>
    <RunAddress>String</RunAddress>
    <RunBags>0</RunBags>
    <RunCode>String</RunCode>
    <RunEta>String</RunEta>
    <RunNeeds>String</RunNeeds>
    <RunNote>String</RunNote>
    <RunStage>String</RunStage>
    <RunZone>String</RunZone>
    <Status>String</Status>
    <Tier>String</Tier>
    <Zone>String</Zone>
  </Od>
  <Pay>
    <DriverPayLineView>
      <ClosedUtc>0001-01-01T00:00:00</ClosedUtc>
      <Code>String</Code>
      <DestinationLabel>String</DestinationLabel>
      <Module>String</Module>
      <OpenedUtc>0001-01-01T00:00:00</OpenedUtc>
      <Pay>0</Pay>
      <PayPlanLabel>String</PayPlanLabel>
      <QtyText>String</QtyText>
      <SourceLabel>String</SourceLabel>
      <Status>String</Status>
      <TicketCode>String</TicketCode>
    </DriverPayLineView>
  </Pay>
  <PayPlanBasis>String</PayPlanBasis>
  <PayPlanName>String</PayPlanName>
  <PayPlanRate>0</PayPlanRate>
  <Phone>String</Phone>
  <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>
  <Rig>
    <Code>String</Code>
    <HoldCode>String</HoldCode>
    <HoldEndUtc>0001-01-01T00:00:00</HoldEndUtc>
    <HoldReason>String</HoldReason>
    <IsFree>false</IsFree>
    <Name>String</Name>
    <RigType>String</RigType>
  </Rig>
  <ServerUtc>0001-01-01T00:00:00</ServerUtc>
  <Truck>
    <Code>String</Code>
    <EstLoad>0</EstLoad>
    <Facility>String</Facility>
    <FacilityShort>String</FacilityShort>
    <HoldCode>String</HoldCode>
    <HoldEndUtc>0001-01-01T00:00:00</HoldEndUtc>
    <HoldReason>String</HoldReason>
    <LoadsToday>0</LoadsToday>
    <NetToday>0</NetToday>
    <NextSiteName>String</NextSiteName>
    <OpenLoadCode>String</OpenLoadCode>
    <OpenLoadId>0</OpenLoadId>
    <OpenLoadPhotos>0</OpenLoadPhotos>
    <QueuePosition>0</QueuePosition>
    <SiteName>String</SiteName>
    <Slot>String</Slot>
    <Stage>String</Stage>
    <StageSinceUtc>0001-01-01T00:00:00</StageSinceUtc>
    <Stamps>
      <DriverStampView>
        <AtUtc>0001-01-01T00:00:00</AtUtc>
        <Note>String</Note>
        <Stage>String</Stage>
      </DriverStampView>
    </Stamps>
    <SupplierName>String</SupplierName>
    <Unit>String</Unit>
  </Truck>
</DriverMeResponse>