Trendsic Platform Service

<back to all web services

CourierBookAvailabilityRequest

The following routes are available for this service:
GET,OPTIONS/v1/book/{Slug}/availability
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 LevelOffer:
    code: Optional[str] = None
    name: Optional[str] = None
    ok: bool = False
    why: Optional[str] = None
    promise: Optional[str] = None
    surcharge: Decimal = decimal.Decimal(0)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Window:
    id: Optional[str] = None
    day_ix: int = 0
    start_min: int = 0
    end_min: int = 0
    label: Optional[str] = None
    asap: bool = False
    levels: List[LevelOffer] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierBookDay:
    day_ix: int = 0
    date: Optional[str] = None
    weekday: int = 0
    closed: bool = False
    windows: List[Window] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierBookAvailabilityResponse:
    in_area: bool = False
    days: List[CourierBookDay] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierBookAvailabilityRequest:
    slug: Optional[str] = None
    profile: Optional[str] = None
    zip: Optional[str] = None

Python CourierBookAvailabilityRequest DTOs

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

HTTP + CSV

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

GET /v1/book/{Slug}/availability HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"InArea":false,"Days":[{"DayIx":0,"Date":"String","Weekday":0,"Closed":false,"Windows":[{"Id":"String","DayIx":0,"StartMin":0,"EndMin":0,"Label":"String","Asap":false,"Levels":[{"Code":"String","Name":"String","Ok":false,"Why":"String","Promise":"String","Surcharge":0}]}]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}