Trendsic Platform Service

CourierStopReturnRequest

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

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


open class CourierStopReturnRequest
{
    open var RunId:Int? = null
    open var Seq:Int? = null
    open var Reason:String? = null
}

open class CourierDriverResponse
{
    open var Courier:CourierDriverView? = null
    open var Result:String? = null
    open var Detail:String? = null
    open var Message:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class CourierDriverView
{
    open var DriverCode:String? = null
    open var Name:String? = null
    open var Online:Boolean? = null
    open var OnRoster:Boolean? = null
    open var Van:CourierVanView? = null
    open var Current:CourierDriverOrder? = null
    open var Queue:ArrayList<CourierDriverOrder> = ArrayList<CourierDriverOrder>()
    open var Aboard:ArrayList<CourierDriverOrder> = ArrayList<CourierDriverOrder>()
    open var Runs:ArrayList<CourierRunView> = ArrayList<CourierRunView>()
    open var UpNext:CourierDriverOrder? = null
}

open class CourierVanView
{
    open var State:String? = null
    open var LeaveByUtc:Date? = null
    open var LeaveByText:String? = null
    open var SlackMin:Int? = null
    open var InVan:Int? = null
    open var Committed:Int? = null
    open var Cap:BigDecimal? = null
    open var CapUnit:String? = null
    open var VehicleUnit:String? = null
    open var CriticalCode:String? = null
    open var DriveMin:Int? = null
    open var FacilityName:String? = null
    open var SendNote:String? = null
}

open class CourierDriverOrder
{
    open var Code:String? = null
    open var CourierStep:String? = null
    open var RouteShape:String? = null
    open var ProfileName:String? = null
    open var UnitOne:String? = null
    open var UnitMany:String? = null
    open var FacilityNoun:String? = null
    open var FacilityName:String? = null
    open var LevelName:String? = null
    open var DueUtc:Date? = null
    open var DueText:String? = null
    open var Units:Int? = null
    open var UnitsFound:Int? = null
    open var Area:String? = null
    open var Minutes:Int? = null
    open var Address:String? = null
    open var Unit:String? = null
    open var City:String? = null
    open var Lat:BigDecimal? = null
    open var Lng:BigDecimal? = null
    open var CustomerName:String? = null
    open var CustomerPhone:String? = null
    open var Handoff:String? = null
    open var GateCode:String? = null
    open var Instructions:String? = null
    open var DropoffAddress:String? = null
    open var DropoffContactName:String? = null
    open var DropLat:BigDecimal? = null
    open var DropLng:BigDecimal? = null
    open var ArrivedUtc:Date? = null
    open var Tags:ArrayList<CourierItemView> = ArrayList<CourierItemView>()
    open var Proof:HashMap<String,String> = HashMap<String,String>()
    open var Photos:HashMap<String,Int> = HashMap<String,Int>()
    open var Needs:ArrayList<String> = ArrayList<String>()
    open var MissedWaitMin:Int? = null
    open var MissedRequireContact:Boolean? = null
    open var MissedRequirePhoto:Boolean? = null
    open var MissedFee:BigDecimal? = null
}

open class CourierItemView
{
    open var CourierItemID:Int? = null
    open var DispatchOdRequestID:Int? = null
    open var Seq:Int? = null
    open var TagCode:String? = null
    open var Custody:String? = null
    open var IsOpen:Boolean? = null
    open var IsMissing:Boolean? = null
    open var MissingReason:String? = null
    open var IsManual:Boolean? = null
    open var ReTagFlag:Boolean? = null
    open var Scanned:Boolean? = null
}

open class CourierRunView
{
    open var CourierRunID:Int? = null
    open var Code:String? = null
    open var Status:String? = null
    open var CourierProfileId:Int? = null
    open var ProfileName:String? = null
    open var CourierFacilityId:Int? = null
    open var FacilityName:String? = null
    open var FacilityAddress:String? = null
    open var DriverContactId:Int? = null
    open var DriverName:String? = null
    open var EquipmentID:Int? = null
    open var VehicleUnit:String? = null
    open var UnitOne:String? = null
    open var UnitMany:String? = null
    open var Units:Int? = null
    open var StopCount:Int? = null
    open var StopsDone:Int? = null
    open var Pay:BigDecimal? = null
    open var BuiltUtc:Date? = null
    open var StartedUtc:Date? = null
    open var CompletedUtc:Date? = null
    open var ToLoad:Int? = null
    open var ToReturn:Int? = null
    open var Stops:ArrayList<CourierStopView> = ArrayList<CourierStopView>()
}

open class CourierStopView
{
    open var Sequence:Int? = null
    open var Status:String? = null
    open var DispatchOdRequestID:Int? = null
    open var Code:String? = null
    open var CourierStep:String? = null
    open var Address:String? = null
    open var Unit:String? = null
    open var City:String? = null
    open var Zip:String? = null
    open var Lat:BigDecimal? = null
    open var Lng:BigDecimal? = null
    open var CustomerName:String? = null
    open var CustomerPhone:String? = null
    open var Handoff:String? = null
    open var GateCode:String? = null
    open var Instructions:String? = null
    open var Units:Int? = null
    open var DueText:String? = null
    open var Note:String? = null
    open var Needs:ArrayList<String> = ArrayList<String>()
    open var Items:ArrayList<CourierItemView> = ArrayList<CourierItemView>()
}

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

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

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>