Trendsic Platform Service

DriverJobStepRequest

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


export class DriverStampView
{
    public Stage: string;
    public AtUtc: string;
    public Note: string;

    public constructor(init?: Partial<DriverStampView>) { (Object as any).assign(this, init); }
}

export class DriverTruckView
{
    public Code: string;
    public Stage: string;
    public StageSinceUtc?: string;
    public LoadsToday: number;
    public NetToday: number;
    public EstLoad?: number;
    public Slot: string;
    public SiteName: string;
    public SupplierName: string;
    public NextSiteName: string;
    public Facility: string;
    public FacilityShort: string;
    public Unit: string;
    public QueuePosition?: number;
    public HoldCode: string;
    public HoldReason: string;
    public HoldEndUtc?: string;
    public OpenLoadId?: number;
    public OpenLoadCode: string;
    public OpenLoadPhotos: number;
    public Stamps: DriverStampView[] = [];

    public constructor(init?: Partial<DriverTruckView>) { (Object as any).assign(this, init); }
}

export class DriverRigView
{
    public Code: string;
    public Name: string;
    public RigType: string;
    public IsFree: boolean;
    public HoldCode: string;
    public HoldReason: string;
    public HoldEndUtc?: string;

    public constructor(init?: Partial<DriverRigView>) { (Object as any).assign(this, init); }
}

export class DriverJobView
{
    public Kind: string;
    public Code: string;
    public Cargo: string;
    public Customer: string;
    public CustomerPhone: string;
    public HoldContact: string;
    public HoldPhone: string;
    public FromLoc: string;
    public ToLoc: string;
    public Miles: number;
    public WindowText: string;
    public Stage: string;
    public Rate?: number;
    public RequiredRig: string;
    public EtaText: string;
    public OfferExpiresUtc?: string;
    public RequestId?: number;
    public LoadId?: number;
    public LoadCode: string;
    public LoadPay?: number;
    public Photos: number;
    public Stamps: DriverStampView[] = [];

    public constructor(init?: Partial<DriverJobView>) { (Object as any).assign(this, init); }
}

export class DriverOdView
{
    public Code: string;
    public Name: string;
    public Zone: string;
    public Status: string;
    public Tier: string;
    public Capabilities: string;
    public PingCode: string;
    public PingAddress: string;
    public PingZone: string;
    public PingBags?: number;
    public PingNeeds: string;
    public PingNote: string;
    public PingExpiresUtc?: string;
    public RunCode: string;
    public RunAddress: string;
    public RunZone: string;
    public RunBags?: number;
    public RunStage: string;
    public RunNeeds: string;
    public RunNote: string;
    public RunEta: string;
    public OdBase?: number;
    public OdPerBag?: number;
    public HoldCode: string;
    public HoldReason: string;
    public HoldEndUtc?: string;

    public constructor(init?: Partial<DriverOdView>) { (Object as any).assign(this, init); }
}

export class DispatchIncidentMessageView
{
    public MessageId: number;
    public Who: string;
    public Role: string;
    public Msg: string;
    public AtUtc: string;

    public constructor(init?: Partial<DispatchIncidentMessageView>) { (Object as any).assign(this, init); }
}

export class DriverIncidentView
{
    public IncidentId: number;
    public Code: string;
    public Kind: string;
    public KindDetail: string;
    public Status: string;
    public LoadCode: string;
    public TruckCode: string;
    public LocationText: string;
    public DriverPref: string;
    public TruckRecovery: string;
    public LoadRecovery: string;
    public TransloadTruckCode: string;
    public HoldCode: string;
    public OpenedUtc: string;
    public ResolvedUtc?: string;
    public Messages: DispatchIncidentMessageView[] = [];

    public constructor(init?: Partial<DriverIncidentView>) { (Object as any).assign(this, init); }
}

export class DriverPayLineView
{
    public Code: string;
    public Module: string;
    public SourceLabel: string;
    public DestinationLabel: string;
    public QtyText: string;
    public Pay?: number;
    public PayPlanLabel: string;
    public Status: string;
    public ClosedUtc?: string;
    public OpenedUtc: string;
    public TicketCode: string;

    public constructor(init?: Partial<DriverPayLineView>) { (Object as any).assign(this, init); }
}

export class DriverMeResponse
{
    public ContactId: number;
    public Name: string;
    public Phone: string;
    public PayPlanName: string;
    public PayPlanBasis: string;
    public PayPlanRate?: number;
    public Truck: DriverTruckView;
    public Rig: DriverRigView;
    public Jobs: DriverJobView[] = [];
    public Od: DriverOdView;
    public Incidents: DriverIncidentView[] = [];
    public Pay: DriverPayLineView[] = [];
    public ServerUtc: string;
    public Message: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<DriverMeResponse>) { (Object as any).assign(this, init); }
}

export class DriverJobStepRequest
{
    public Code: string;
    public Step: string;
    public PodName: string;

    public constructor(init?: Partial<DriverJobStepRequest>) { (Object as any).assign(this, init); }
}

TypeScript DriverJobStepRequest 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}/step HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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>