Trendsic Platform Service

DriverPingAnswerRequest

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

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class DispatchIncidentMessageView
            Public Overridable Property MessageId As Integer
            Public Overridable Property Who As String
            Public Overridable Property Role As String
            Public Overridable Property Msg As String
            Public Overridable Property AtUtc As Date
        End Class

        Public Partial Class DriverIncidentView
            Public Overridable Property IncidentId As Integer
            Public Overridable Property Code As String
            Public Overridable Property Kind As String
            Public Overridable Property KindDetail As String
            Public Overridable Property Status As String
            Public Overridable Property LoadCode As String
            Public Overridable Property TruckCode As String
            Public Overridable Property LocationText As String
            Public Overridable Property DriverPref As String
            Public Overridable Property TruckRecovery As String
            Public Overridable Property LoadRecovery As String
            Public Overridable Property TransloadTruckCode As String
            Public Overridable Property HoldCode As String
            Public Overridable Property OpenedUtc As Date
            Public Overridable Property ResolvedUtc As Date?
            Public Overridable Property Messages As List(Of DispatchIncidentMessageView) = New List(Of DispatchIncidentMessageView)
        End Class

        Public Partial Class DriverJobView
            Public Overridable Property Kind As String
            Public Overridable Property Code As String
            Public Overridable Property Cargo As String
            Public Overridable Property Customer As String
            Public Overridable Property CustomerPhone As String
            Public Overridable Property HoldContact As String
            Public Overridable Property HoldPhone As String
            Public Overridable Property FromLoc As String
            Public Overridable Property ToLoc As String
            Public Overridable Property Miles As Integer
            Public Overridable Property WindowText As String
            Public Overridable Property Stage As String
            Public Overridable Property Rate As Decimal?
            Public Overridable Property RequiredRig As String
            Public Overridable Property EtaText As String
            Public Overridable Property OfferExpiresUtc As Date?
            Public Overridable Property RequestId As Integer?
            Public Overridable Property LoadId As Integer?
            Public Overridable Property LoadCode As String
            Public Overridable Property LoadPay As Decimal?
            Public Overridable Property Photos As Integer
            Public Overridable Property Stamps As List(Of DriverStampView) = New List(Of DriverStampView)
        End Class

        Public Partial Class DriverMeResponse
            Public Overridable Property ContactId As Integer
            Public Overridable Property Name As String
            Public Overridable Property Phone As String
            Public Overridable Property PayPlanName As String
            Public Overridable Property PayPlanBasis As String
            Public Overridable Property PayPlanRate As Decimal?
            Public Overridable Property Truck As DriverTruckView
            Public Overridable Property Rig As DriverRigView
            Public Overridable Property Jobs As List(Of DriverJobView) = New List(Of DriverJobView)
            Public Overridable Property Od As DriverOdView
            Public Overridable Property Incidents As List(Of DriverIncidentView) = New List(Of DriverIncidentView)
            Public Overridable Property Pay As List(Of DriverPayLineView) = New List(Of DriverPayLineView)
            Public Overridable Property ServerUtc As Date
            Public Overridable Property Message As String
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class DriverOdView
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property Zone As String
            Public Overridable Property Status As String
            Public Overridable Property Tier As String
            Public Overridable Property Capabilities As String
            Public Overridable Property PingCode As String
            Public Overridable Property PingAddress As String
            Public Overridable Property PingZone As String
            Public Overridable Property PingBags As Integer?
            Public Overridable Property PingNeeds As String
            Public Overridable Property PingNote As String
            Public Overridable Property PingExpiresUtc As Date?
            Public Overridable Property RunCode As String
            Public Overridable Property RunAddress As String
            Public Overridable Property RunZone As String
            Public Overridable Property RunBags As Integer?
            Public Overridable Property RunStage As String
            Public Overridable Property RunNeeds As String
            Public Overridable Property RunNote As String
            Public Overridable Property RunEta As String
            Public Overridable Property OdBase As Decimal?
            Public Overridable Property OdPerBag As Decimal?
            Public Overridable Property HoldCode As String
            Public Overridable Property HoldReason As String
            Public Overridable Property HoldEndUtc As Date?
        End Class

        Public Partial Class DriverPayLineView
            Public Overridable Property Code As String
            Public Overridable Property [Module] As String
            Public Overridable Property SourceLabel As String
            Public Overridable Property DestinationLabel As String
            Public Overridable Property QtyText As String
            Public Overridable Property Pay As Decimal?
            Public Overridable Property PayPlanLabel As String
            Public Overridable Property Status As String
            Public Overridable Property ClosedUtc As Date?
            Public Overridable Property OpenedUtc As Date
            Public Overridable Property TicketCode As String
        End Class

        Public Partial Class DriverPingAnswerRequest
            Public Overridable Property Code As String
            Public Overridable Property Accept As Boolean
        End Class

        Public Partial Class DriverRigView
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property RigType As String
            Public Overridable Property IsFree As Boolean
            Public Overridable Property HoldCode As String
            Public Overridable Property HoldReason As String
            Public Overridable Property HoldEndUtc As Date?
        End Class

        Public Partial Class DriverStampView
            Public Overridable Property Stage As String
            Public Overridable Property AtUtc As Date
            Public Overridable Property Note As String
        End Class

        Public Partial Class DriverTruckView
            Public Overridable Property Code As String
            Public Overridable Property Stage As String
            Public Overridable Property StageSinceUtc As Date?
            Public Overridable Property LoadsToday As Integer
            Public Overridable Property NetToday As Decimal
            Public Overridable Property EstLoad As Decimal?
            Public Overridable Property Slot As String
            Public Overridable Property SiteName As String
            Public Overridable Property SupplierName As String
            Public Overridable Property NextSiteName As String
            Public Overridable Property Facility As String
            Public Overridable Property FacilityShort As String
            Public Overridable Property Unit As String
            Public Overridable Property QueuePosition As Integer?
            Public Overridable Property HoldCode As String
            Public Overridable Property HoldReason As String
            Public Overridable Property HoldEndUtc As Date?
            Public Overridable Property OpenLoadId As Integer?
            Public Overridable Property OpenLoadCode As String
            Public Overridable Property OpenLoadPhotos As Integer
            Public Overridable Property Stamps As List(Of DriverStampView) = New List(Of DriverStampView)
        End Class
    End Namespace
End Namespace

VB.NET DriverPingAnswerRequest 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}/answer HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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>