Trendsic Platform Service

CourierStopScanRequest

The following routes are available for this service:
POST,OPTIONS	/v1/worker/dispatch/od/runs/{RunId}/stops/{Seq}/scan

import Foundation
import ServiceStack

public class CourierStopScanRequest : Codable
{
    public var runId:Int
    public var seq:Int
    public var tagCode:String
    public var lat:Double?
    public var lng:Double?

    required public init(){}
}

public class CourierDriverResponse : Codable
{
    public var courier:CourierDriverView
    public var result:String
    public var detail:String
    public var message:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class CourierDriverView : Codable
{
    public var driverCode:String
    public var name:String
    public var online:Bool
    public var onRoster:Bool
    public var van:CourierVanView
    public var current:CourierDriverOrder
    public var queue:[CourierDriverOrder] = []
    public var aboard:[CourierDriverOrder] = []
    public var runs:[CourierRunView] = []
    public var upNext:CourierDriverOrder

    required public init(){}
}

public class CourierVanView : Codable
{
    public var state:String
    public var leaveByUtc:Date?
    public var leaveByText:String
    public var slackMin:Int?
    public var inVan:Int
    public var committed:Int
    public var cap:Double?
    public var capUnit:String
    public var vehicleUnit:String
    public var criticalCode:String
    public var driveMin:Int
    public var facilityName:String
    public var sendNote:String

    required public init(){}
}

public class CourierDriverOrder : Codable
{
    public var code:String
    public var courierStep:String
    public var routeShape:String
    public var profileName:String
    public var unitOne:String
    public var unitMany:String
    public var facilityNoun:String
    public var facilityName:String
    public var levelName:String
    public var dueUtc:Date?
    public var dueText:String
    public var units:Int
    public var unitsFound:Int?
    public var area:String
    public var minutes:Int?
    public var address:String
    public var unit:String
    public var city:String
    public var lat:Double?
    public var lng:Double?
    public var customerName:String
    public var customerPhone:String
    public var handoff:String
    public var gateCode:String
    public var instructions:String
    public var dropoffAddress:String
    public var dropoffContactName:String
    public var dropLat:Double?
    public var dropLng:Double?
    public var arrivedUtc:Date?
    public var tags:[CourierItemView] = []
    public var proof:[String:String] = [:]
    public var photos:[String:Int] = [:]
    public var needs:[String] = []
    public var missedWaitMin:Int
    public var missedRequireContact:Bool
    public var missedRequirePhoto:Bool
    public var missedFee:Double

    required public init(){}
}

public class CourierItemView : Codable
{
    public var courierItemID:Int
    public var dispatchOdRequestID:Int
    public var seq:Int
    public var tagCode:String
    public var custody:String
    public var isOpen:Bool
    public var isMissing:Bool
    public var missingReason:String
    public var isManual:Bool
    public var reTagFlag:Bool
    public var scanned:Bool

    required public init(){}
}

public class CourierRunView : Codable
{
    public var courierRunID:Int
    public var code:String
    public var status:String
    public var courierProfileId:Int
    public var profileName:String
    public var courierFacilityId:Int
    public var facilityName:String
    public var facilityAddress:String
    public var driverContactId:Int?
    public var driverName:String
    public var equipmentID:Int?
    public var vehicleUnit:String
    public var unitOne:String
    public var unitMany:String
    public var units:Int
    public var stopCount:Int
    public var stopsDone:Int
    public var pay:Double?
    public var builtUtc:Date?
    public var startedUtc:Date?
    public var completedUtc:Date?
    public var toLoad:Int
    public var toReturn:Int
    public var stops:[CourierStopView] = []

    required public init(){}
}

public class CourierStopView : Codable
{
    public var sequence:Int
    public var status:String
    public var dispatchOdRequestID:Int
    public var code:String
    public var courierStep:String
    public var address:String
    public var unit:String
    public var city:String
    public var zip:String
    public var lat:Double?
    public var lng:Double?
    public var customerName:String
    public var customerPhone:String
    public var handoff:String
    public var gateCode:String
    public var instructions:String
    public var units:Int
    public var dueText:String
    public var note:String
    public var needs:[String] = []
    public var items:[CourierItemView] = []

    required public init(){}
}

Swift CourierStopScanRequest 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/od/runs/{RunId}/stops/{Seq}/scan HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CourierStopScanRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Lat>0</Lat>
  <Lng>0</Lng>
  <RunId>0</RunId>
  <Seq>0</Seq>
  <TagCode>String</TagCode>
</CourierStopScanRequest>

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

<CourierDriverResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Courier>
    <Aboard>
      <CourierDriverOrder>
        <Address>String</Address>
        <Area>String</Area>
        <ArrivedUtc>0001-01-01T00:00:00</ArrivedUtc>
        <City>String</City>
        <Code>String</Code>
        <CourierStep>String</CourierStep>
        <CustomerName>String</CustomerName>
        <CustomerPhone>String</CustomerPhone>
        <DropLat>0</DropLat>
        <DropLng>0</DropLng>
        <DropoffAddress>String</DropoffAddress>
        <DropoffContactName>String</DropoffContactName>
        <DueText>String</DueText>
        <DueUtc>0001-01-01T00:00:00</DueUtc>
        <FacilityName>String</FacilityName>
        <FacilityNoun>String</FacilityNoun>
        <GateCode>String</GateCode>
        <Handoff>String</Handoff>
        <Instructions>String</Instructions>
        <Lat>0</Lat>
        <LevelName>String</LevelName>
        <Lng>0</Lng>
        <Minutes>0</Minutes>
        <MissedFee>0</MissedFee>
        <MissedRequireContact>false</MissedRequireContact>
        <MissedRequirePhoto>false</MissedRequirePhoto>
        <MissedWaitMin>0</MissedWaitMin>
        <Needs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </Needs>
        <Photos xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringint>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>0</d5p1:Value>
          </d5p1:KeyValueOfstringint>
        </Photos>
        <ProfileName>String</ProfileName>
        <Proof xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Proof>
        <RouteShape>String</RouteShape>
        <Tags>
          <CourierItemView>
            <CourierItemID>0</CourierItemID>
            <Custody>String</Custody>
            <DispatchOdRequestID>0</DispatchOdRequestID>
            <IsManual>false</IsManual>
            <IsMissing>false</IsMissing>
            <IsOpen>false</IsOpen>
            <MissingReason>String</MissingReason>
            <ReTagFlag>false</ReTagFlag>
            <Scanned>false</Scanned>
            <Seq>0</Seq>
            <TagCode>String</TagCode>
          </CourierItemView>
        </Tags>
        <Unit>String</Unit>
        <UnitMany>String</UnitMany>
        <UnitOne>String</UnitOne>
        <Units>0</Units>
        <UnitsFound>0</UnitsFound>
      </CourierDriverOrder>
    </Aboard>
    <Current>
      <Address>String</Address>
      <Area>String</Area>
      <ArrivedUtc>0001-01-01T00:00:00</ArrivedUtc>
      <City>String</City>
      <Code>String</Code>
      <CourierStep>String</CourierStep>
      <CustomerName>String</CustomerName>
      <CustomerPhone>String</CustomerPhone>
      <DropLat>0</DropLat>
      <DropLng>0</DropLng>
      <DropoffAddress>String</DropoffAddress>
      <DropoffContactName>String</DropoffContactName>
      <DueText>String</DueText>
      <DueUtc>0001-01-01T00:00:00</DueUtc>
      <FacilityName>String</FacilityName>
      <FacilityNoun>String</FacilityNoun>
      <GateCode>String</GateCode>
      <Handoff>String</Handoff>
      <Instructions>String</Instructions>
      <Lat>0</Lat>
      <LevelName>String</LevelName>
      <Lng>0</Lng>
      <Minutes>0</Minutes>
      <MissedFee>0</MissedFee>
      <MissedRequireContact>false</MissedRequireContact>
      <MissedRequirePhoto>false</MissedRequirePhoto>
      <MissedWaitMin>0</MissedWaitMin>
      <Needs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Needs>
      <Photos xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringint>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:KeyValueOfstringint>
      </Photos>
      <ProfileName>String</ProfileName>
      <Proof xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Proof>
      <RouteShape>String</RouteShape>
      <Tags>
        <CourierItemView>
          <CourierItemID>0</CourierItemID>
          <Custody>String</Custody>
          <DispatchOdRequestID>0</DispatchOdRequestID>
          <IsManual>false</IsManual>
          <IsMissing>false</IsMissing>
          <IsOpen>false</IsOpen>
          <MissingReason>String</MissingReason>
          <ReTagFlag>false</ReTagFlag>
          <Scanned>false</Scanned>
          <Seq>0</Seq>
          <TagCode>String</TagCode>
        </CourierItemView>
      </Tags>
      <Unit>String</Unit>
      <UnitMany>String</UnitMany>
      <UnitOne>String</UnitOne>
      <Units>0</Units>
      <UnitsFound>0</UnitsFound>
    </Current>
    <DriverCode>String</DriverCode>
    <Name>String</Name>
    <OnRoster>false</OnRoster>
    <Online>false</Online>
    <Queue>
      <CourierDriverOrder>
        <Address>String</Address>
        <Area>String</Area>
        <ArrivedUtc>0001-01-01T00:00:00</ArrivedUtc>
        <City>String</City>
        <Code>String</Code>
        <CourierStep>String</CourierStep>
        <CustomerName>String</CustomerName>
        <CustomerPhone>String</CustomerPhone>
        <DropLat>0</DropLat>
        <DropLng>0</DropLng>
        <DropoffAddress>String</DropoffAddress>
        <DropoffContactName>String</DropoffContactName>
        <DueText>String</DueText>
        <DueUtc>0001-01-01T00:00:00</DueUtc>
        <FacilityName>String</FacilityName>
        <FacilityNoun>String</FacilityNoun>
        <GateCode>String</GateCode>
        <Handoff>String</Handoff>
        <Instructions>String</Instructions>
        <Lat>0</Lat>
        <LevelName>String</LevelName>
        <Lng>0</Lng>
        <Minutes>0</Minutes>
        <MissedFee>0</MissedFee>
        <MissedRequireContact>false</MissedRequireContact>
        <MissedRequirePhoto>false</MissedRequirePhoto>
        <MissedWaitMin>0</MissedWaitMin>
        <Needs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </Needs>
        <Photos xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringint>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>0</d5p1:Value>
          </d5p1:KeyValueOfstringint>
        </Photos>
        <ProfileName>String</ProfileName>
        <Proof xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Proof>
        <RouteShape>String</RouteShape>
        <Tags>
          <CourierItemView>
            <CourierItemID>0</CourierItemID>
            <Custody>String</Custody>
            <DispatchOdRequestID>0</DispatchOdRequestID>
            <IsManual>false</IsManual>
            <IsMissing>false</IsMissing>
            <IsOpen>false</IsOpen>
            <MissingReason>String</MissingReason>
            <ReTagFlag>false</ReTagFlag>
            <Scanned>false</Scanned>
            <Seq>0</Seq>
            <TagCode>String</TagCode>
          </CourierItemView>
        </Tags>
        <Unit>String</Unit>
        <UnitMany>String</UnitMany>
        <UnitOne>String</UnitOne>
        <Units>0</Units>
        <UnitsFound>0</UnitsFound>
      </CourierDriverOrder>
    </Queue>
    <Runs>
      <CourierRunView>
        <BuiltUtc>0001-01-01T00:00:00</BuiltUtc>
        <Code>String</Code>
        <CompletedUtc>0001-01-01T00:00:00</CompletedUtc>
        <CourierFacilityId>0</CourierFacilityId>
        <CourierProfileId>0</CourierProfileId>
        <CourierRunID>0</CourierRunID>
        <DriverContactId>0</DriverContactId>
        <DriverName>String</DriverName>
        <EquipmentID>0</EquipmentID>
        <FacilityAddress>String</FacilityAddress>
        <FacilityName>String</FacilityName>
        <Pay>0</Pay>
        <ProfileName>String</ProfileName>
        <StartedUtc>0001-01-01T00:00:00</StartedUtc>
        <Status>String</Status>
        <StopCount>0</StopCount>
        <Stops>
          <CourierStopView>
            <Address>String</Address>
            <City>String</City>
            <Code>String</Code>
            <CourierStep>String</CourierStep>
            <CustomerName>String</CustomerName>
            <CustomerPhone>String</CustomerPhone>
            <DispatchOdRequestID>0</DispatchOdRequestID>
            <DueText>String</DueText>
            <GateCode>String</GateCode>
            <Handoff>String</Handoff>
            <Instructions>String</Instructions>
            <Items>
              <CourierItemView>
                <CourierItemID>0</CourierItemID>
                <Custody>String</Custody>
                <DispatchOdRequestID>0</DispatchOdRequestID>
                <IsManual>false</IsManual>
                <IsMissing>false</IsMissing>
                <IsOpen>false</IsOpen>
                <MissingReason>String</MissingReason>
                <ReTagFlag>false</ReTagFlag>
                <Scanned>false</Scanned>
                <Seq>0</Seq>
                <TagCode>String</TagCode>
              </CourierItemView>
            </Items>
            <Lat>0</Lat>
            <Lng>0</Lng>
            <Needs xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </Needs>
            <Note>String</Note>
            <Sequence>0</Sequence>
            <Status>String</Status>
            <Unit>String</Unit>
            <Units>0</Units>
            <Zip>String</Zip>
          </CourierStopView>
        </Stops>
        <StopsDone>0</StopsDone>
        <ToLoad>0</ToLoad>
        <ToReturn>0</ToReturn>
        <UnitMany>String</UnitMany>
        <UnitOne>String</UnitOne>
        <Units>0</Units>
        <VehicleUnit>String</VehicleUnit>
      </CourierRunView>
    </Runs>
    <UpNext>
      <Address>String</Address>
      <Area>String</Area>
      <ArrivedUtc>0001-01-01T00:00:00</ArrivedUtc>
      <City>String</City>
      <Code>String</Code>
      <CourierStep>String</CourierStep>
      <CustomerName>String</CustomerName>
      <CustomerPhone>String</CustomerPhone>
      <DropLat>0</DropLat>
      <DropLng>0</DropLng>
      <DropoffAddress>String</DropoffAddress>
      <DropoffContactName>String</DropoffContactName>
      <DueText>String</DueText>
      <DueUtc>0001-01-01T00:00:00</DueUtc>
      <FacilityName>String</FacilityName>
      <FacilityNoun>String</FacilityNoun>
      <GateCode>String</GateCode>
      <Handoff>String</Handoff>
      <Instructions>String</Instructions>
      <Lat>0</Lat>
      <LevelName>String</LevelName>
      <Lng>0</Lng>
      <Minutes>0</Minutes>
      <MissedFee>0</MissedFee>
      <MissedRequireContact>false</MissedRequireContact>
      <MissedRequirePhoto>false</MissedRequirePhoto>
      <MissedWaitMin>0</MissedWaitMin>
      <Needs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Needs>
      <Photos xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringint>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:KeyValueOfstringint>
      </Photos>
      <ProfileName>String</ProfileName>
      <Proof xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Proof>
      <RouteShape>String</RouteShape>
      <Tags>
        <CourierItemView>
          <CourierItemID>0</CourierItemID>
          <Custody>String</Custody>
          <DispatchOdRequestID>0</DispatchOdRequestID>
          <IsManual>false</IsManual>
          <IsMissing>false</IsMissing>
          <IsOpen>false</IsOpen>
          <MissingReason>String</MissingReason>
          <ReTagFlag>false</ReTagFlag>
          <Scanned>false</Scanned>
          <Seq>0</Seq>
          <TagCode>String</TagCode>
        </CourierItemView>
      </Tags>
      <Unit>String</Unit>
      <UnitMany>String</UnitMany>
      <UnitOne>String</UnitOne>
      <Units>0</Units>
      <UnitsFound>0</UnitsFound>
    </UpNext>
    <Van>
      <Cap>0</Cap>
      <CapUnit>String</CapUnit>
      <Committed>0</Committed>
      <CriticalCode>String</CriticalCode>
      <DriveMin>0</DriveMin>
      <FacilityName>String</FacilityName>
      <InVan>0</InVan>
      <LeaveByText>String</LeaveByText>
      <LeaveByUtc>0001-01-01T00:00:00</LeaveByUtc>
      <SendNote>String</SendNote>
      <SlackMin>0</SlackMin>
      <State>String</State>
      <VehicleUnit>String</VehicleUnit>
    </Van>
  </Courier>
  <Detail>String</Detail>
  <Message>String</Message>
  <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>
  <Result>String</Result>
</CourierDriverResponse>