Trendsic Platform Service

CourierRunCancelRequest

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

**CourierRunCancelRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	int	No

**CourierRunResponse** Parameters:
Name	Parameter	Data Type	Required
Runs	form	List<CourierRunView>	No
Run	form	CourierRunView	No
Message	form	string	No
ResponseStatus	form	ResponseStatus	No

**CourierRunView** Parameters:
Name	Parameter	Data Type	Required
CourierRunID	form	int	No
Code	form	string	No
Status	form	string	No
CourierProfileId	form	int	No
ProfileName	form	string	No
CourierFacilityId	form	int	No
FacilityName	form	string	No
FacilityAddress	form	string	No
DriverContactId	form	int?	No
DriverName	form	string	No
EquipmentID	form	int?	No
VehicleUnit	form	string	No
UnitOne	form	string	No
UnitMany	form	string	No
Units	form	int	No
StopCount	form	int	No
StopsDone	form	int	No
Pay	form	decimal?	No
BuiltUtc	form	DateTime?	No
StartedUtc	form	DateTime?	No
CompletedUtc	form	DateTime?	No
ToLoad	form	int	No
ToReturn	form	int	No
Stops	form	List<CourierStopView>	No

**CourierStopView** Parameters:
Name	Parameter	Data Type	Required
Sequence	form	int	No
Status	form	string	No
DispatchOdRequestID	form	int	No
Code	form	string	No
CourierStep	form	string	No
Address	form	string	No
Unit	form	string	No
City	form	string	No
Zip	form	string	No
Lat	form	decimal?	No
Lng	form	decimal?	No
CustomerName	form	string	No
CustomerPhone	form	string	No
Handoff	form	string	No
GateCode	form	string	No
Instructions	form	string	No
Units	form	int	No
DueText	form	string	No
Note	form	string	No
Needs	form	List<string>	No
Items	form	List<CourierItemView>	No

**CourierItemView** Parameters:
Name	Parameter	Data Type	Required
CourierItemID	form	int	No
DispatchOdRequestID	form	int	No
Seq	form	int	No
TagCode	form	string	No
Custody	form	string	No
IsOpen	form	bool	No
IsMissing	form	bool	No
MissingReason	form	string	No
IsManual	form	bool	No
ReTagFlag	form	bool	No
Scanned	form	bool	No

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>