Trendsic Platform Service

<back to all web services

DispatchPickupPageRequest

The following routes are available for this service:
GET,OPTIONS/v1/dispatch/public/pickup/{SchedulerUrl}
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 DispatchZoneView:
    zone: Optional[str] = None
    base: Decimal = decimal.Decimal(0)
    per_bag: Decimal = decimal.Decimal(0)
    premium_uplift_pct: Decimal = decimal.Decimal(0)
    drivers: int = 0
    idle_drivers: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchNeedView:
    id: Optional[str] = None
    label: Optional[str] = None
    sub: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchPickupPageResponse:
    company_name: Optional[str] = None
    zones: List[DispatchZoneView] = field(default_factory=list)
    needs: List[DispatchNeedView] = field(default_factory=list)
    card_enabled: bool = False
    publishable_key: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchPickupPageRequest:
    scheduler_url: Optional[str] = None

Python DispatchPickupPageRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/dispatch/public/pickup/{SchedulerUrl} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"CompanyName":"String","Zones":[{"Zone":"String","Base":0,"PerBag":0,"PremiumUpliftPct":0,"Drivers":0,"IdleDrivers":0}],"Needs":[{"Id":"String","Label":"String","Sub":"String"}],"CardEnabled":false,"PublishableKey":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}