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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierStopRow:
    kind: Optional[str] = None
    at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    order_code: Optional[str] = None
    units: int = 0
    order_count: Optional[int] = None
    run_code: Optional[str] = None
    stop_seq: Optional[int] = None
    street: Optional[str] = None
    city: Optional[str] = None
    zip: Optional[str] = None
    facility_name: Optional[str] = None
    reason: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierPingFacts:
    busy: bool = False
    radius_mi: Optional[Decimal] = None
    hide_addresses_in_history: bool = False
    ping_radius_mi: Optional[Decimal] = None
    ping_radius_until_utc: Optional[datetime.datetime] = None
    unit_one: Optional[str] = None
    unit_many: Optional[str] = None
    unit_one_es: Optional[str] = None
    unit_many_es: Optional[str] = None
    facility_noun: Optional[str] = None
    facility_noun_es: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierDriverStopsResponse:
    rows: List[CourierStopRow] = field(default_factory=list)
    hidden: bool = False
    facts: Optional[CourierPingFacts] = None
    available: bool = False
    server_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierDriverStopsRequest:
    pass

Python CourierDriverStopsRequest 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.

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>