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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Rows: 
	[
		{
			Kind: String,
			AtUtc: 0001-01-01,
			OrderCode: String,
			Units: 0,
			OrderCount: 0,
			RunCode: String,
			StopSeq: 0,
			Street: String,
			City: String,
			Zip: String,
			FacilityName: String,
			Reason: String
		}
	],
	Hidden: False,
	Facts: 
	{
		Busy: False,
		RadiusMi: 0,
		HideAddressesInHistory: False,
		PingRadiusMi: 0,
		PingRadiusUntilUtc: 0001-01-01,
		UnitOne: String,
		UnitMany: String,
		UnitOneEs: String,
		UnitManyEs: String,
		FacilityNoun: String,
		FacilityNounEs: String
	},
	Available: False,
	ServerUtc: 0001-01-01,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}