Trendsic Platform Service

CourierRunCancelRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dispatch/courier/runs/{Id}/cancel

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


open class CourierRunCancelRequest
{
    open var Id:Int? = null
}

open class CourierRunResponse
{
    open var Runs:ArrayList<CourierRunView> = ArrayList<CourierRunView>()
    open var Run:CourierRunView? = null
    open var Message:String? = null
    open var ResponseStatus:ResponseStatus? = 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>()
}

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
}

Kotlin CourierRunCancelRequest 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/dispatch/courier/runs/{Id}/cancel HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CourierRunCancelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Id>0</Id>
</CourierRunCancelRequest>

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

<CourierRunResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Run>
    <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:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1: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>
  </Run>
  <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:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1: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>
</CourierRunResponse>