Trendsic Platform Service

<back to all web services

CourierDriverStopsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/worker/dispatch/od/stops
CourierDriverStopsResponse Parameters:
NameParameterData TypeRequiredDescription
RowsformList<CourierStopRow>No
HiddenformboolNo
FactsformCourierPingFactsNo
AvailableformboolNo
ServerUtcformDateTimeNo
ResponseStatusformResponseStatusNo
CourierStopRow Parameters:
NameParameterData TypeRequiredDescription
KindformstringNo
AtUtcformDateTimeNo
OrderCodeformstringNo
UnitsformintNo
OrderCountformint?No
RunCodeformstringNo
StopSeqformint?No
StreetformstringNo
CityformstringNo
ZipformstringNo
FacilityNameformstringNo
ReasonformstringNo
CourierPingFacts Parameters:
NameParameterData TypeRequiredDescription
BusyformboolNo
RadiusMiformdecimal?No
HideAddressesInHistoryformboolNo
PingRadiusMiformdecimal?No
PingRadiusUntilUtcformDateTime?No
UnitOneformstringNo
UnitManyformstringNo
UnitOneEsformstringNo
UnitManyEsformstringNo
FacilityNounformstringNo
FacilityNounEsformstringNo

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.

GET /v1/worker/dispatch/od/stops HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CourierDriverStopsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Available>false</Available>
  <Facts>
    <Busy>false</Busy>
    <FacilityNoun>String</FacilityNoun>
    <FacilityNounEs>String</FacilityNounEs>
    <HideAddressesInHistory>false</HideAddressesInHistory>
    <PingRadiusMi>0</PingRadiusMi>
    <PingRadiusUntilUtc>0001-01-01T00:00:00</PingRadiusUntilUtc>
    <RadiusMi>0</RadiusMi>
    <UnitMany>String</UnitMany>
    <UnitManyEs>String</UnitManyEs>
    <UnitOne>String</UnitOne>
    <UnitOneEs>String</UnitOneEs>
  </Facts>
  <Hidden>false</Hidden>
  <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>
  <Rows>
    <CourierStopRow>
      <AtUtc>0001-01-01T00:00:00</AtUtc>
      <City>String</City>
      <FacilityName>String</FacilityName>
      <Kind>String</Kind>
      <OrderCode>String</OrderCode>
      <OrderCount>0</OrderCount>
      <Reason>String</Reason>
      <RunCode>String</RunCode>
      <StopSeq>0</StopSeq>
      <Street>String</Street>
      <Units>0</Units>
      <Zip>String</Zip>
    </CourierStopRow>
  </Rows>
  <ServerUtc>0001-01-01T00:00:00</ServerUtc>
</CourierDriverStopsResponse>