Trendsic Platform Service

DriverJobAnswerRequest

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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class DriverJobAnswerRequest
{
    open var Code:String? = null
    open var Accept:Boolean? = null
}

open class DriverMeResponse
{
    open var ContactId:Int? = null
    open var Name:String? = null
    open var Phone:String? = null
    open var PayPlanName:String? = null
    open var PayPlanBasis:String? = null
    open var PayPlanRate:BigDecimal? = null
    open var Truck:DriverTruckView? = null
    open var Rig:DriverRigView? = null
    open var Jobs:ArrayList<DriverJobView> = ArrayList<DriverJobView>()
    open var Od:DriverOdView? = null
    open var Incidents:ArrayList<DriverIncidentView> = ArrayList<DriverIncidentView>()
    open var Pay:ArrayList<DriverPayLineView> = ArrayList<DriverPayLineView>()
    open var ServerUtc:Date? = null
    open var Message:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class DriverTruckView
{
    open var Code:String? = null
    open var Stage:String? = null
    open var StageSinceUtc:Date? = null
    open var LoadsToday:Int? = null
    open var NetToday:BigDecimal? = null
    open var EstLoad:BigDecimal? = null
    open var Slot:String? = null
    open var SiteName:String? = null
    open var SupplierName:String? = null
    open var NextSiteName:String? = null
    open var Facility:String? = null
    open var FacilityShort:String? = null
    open var Unit:String? = null
    open var QueuePosition:Int? = null
    open var HoldCode:String? = null
    open var HoldReason:String? = null
    open var HoldEndUtc:Date? = null
    open var OpenLoadId:Int? = null
    open var OpenLoadCode:String? = null
    open var OpenLoadPhotos:Int? = null
    open var Stamps:ArrayList<DriverStampView> = ArrayList<DriverStampView>()
}

open class DriverStampView
{
    open var Stage:String? = null
    open var AtUtc:Date? = null
    open var Note:String? = null
}

open class DriverRigView
{
    open var Code:String? = null
    open var Name:String? = null
    open var RigType:String? = null
    open var IsFree:Boolean? = null
    open var HoldCode:String? = null
    open var HoldReason:String? = null
    open var HoldEndUtc:Date? = null
}

open class DriverJobView
{
    open var Kind:String? = null
    open var Code:String? = null
    open var Cargo:String? = null
    open var Customer:String? = null
    open var CustomerPhone:String? = null
    open var HoldContact:String? = null
    open var HoldPhone:String? = null
    open var FromLoc:String? = null
    open var ToLoc:String? = null
    open var Miles:Int? = null
    open var WindowText:String? = null
    open var Stage:String? = null
    open var Rate:BigDecimal? = null
    open var RequiredRig:String? = null
    open var EtaText:String? = null
    open var OfferExpiresUtc:Date? = null
    open var RequestId:Int? = null
    open var LoadId:Int? = null
    open var LoadCode:String? = null
    open var LoadPay:BigDecimal? = null
    open var Photos:Int? = null
    open var Stamps:ArrayList<DriverStampView> = ArrayList<DriverStampView>()
}

open class DriverOdView
{
    open var Code:String? = null
    open var Name:String? = null
    open var Zone:String? = null
    open var Status:String? = null
    open var Tier:String? = null
    open var Capabilities:String? = null
    open var PingCode:String? = null
    open var PingAddress:String? = null
    open var PingZone:String? = null
    open var PingBags:Int? = null
    open var PingNeeds:String? = null
    open var PingNote:String? = null
    open var PingExpiresUtc:Date? = null
    open var RunCode:String? = null
    open var RunAddress:String? = null
    open var RunZone:String? = null
    open var RunBags:Int? = null
    open var RunStage:String? = null
    open var RunNeeds:String? = null
    open var RunNote:String? = null
    open var RunEta:String? = null
    open var OdBase:BigDecimal? = null
    open var OdPerBag:BigDecimal? = null
    open var HoldCode:String? = null
    open var HoldReason:String? = null
    open var HoldEndUtc:Date? = null
}

open class DriverIncidentView
{
    open var IncidentId:Int? = null
    open var Code:String? = null
    open var Kind:String? = null
    open var KindDetail:String? = null
    open var Status:String? = null
    open var LoadCode:String? = null
    open var TruckCode:String? = null
    open var LocationText:String? = null
    open var DriverPref:String? = null
    open var TruckRecovery:String? = null
    open var LoadRecovery:String? = null
    open var TransloadTruckCode:String? = null
    open var HoldCode:String? = null
    open var OpenedUtc:Date? = null
    open var ResolvedUtc:Date? = null
    open var Messages:ArrayList<DispatchIncidentMessageView> = ArrayList<DispatchIncidentMessageView>()
}

open class DispatchIncidentMessageView
{
    open var MessageId:Int? = null
    open var Who:String? = null
    open var Role:String? = null
    open var Msg:String? = null
    open var AtUtc:Date? = null
}

open class DriverPayLineView
{
    open var Code:String? = null
    open var Module:String? = null
    open var SourceLabel:String? = null
    open var DestinationLabel:String? = null
    open var QtyText:String? = null
    open var Pay:BigDecimal? = null
    open var PayPlanLabel:String? = null
    open var Status:String? = null
    open var ClosedUtc:Date? = null
    open var OpenedUtc:Date? = null
    open var TicketCode:String? = null
}

Kotlin DriverJobAnswerRequest 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/job/{Code}/answer HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DriverJobAnswerRequest 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>
</DriverJobAnswerRequest>

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>