Trendsic Platform Service

CourierAvailabilityRequest

The following routes are available for this service:
GET,OPTIONS	/v1/dispatch/courier/profiles/{Id}/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 Availability:
    in_area: bool = False
    zip_checked: bool = False
    closed: bool = False
    windows: List[Window] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierAvailabilityResponse:
    availability: Optional[Availability] = None
    date: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierAvailabilityRequest:
    id: int = 0
    date: Optional[str] = None
    zip: Optional[str] = None

Python CourierAvailabilityRequest 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/dispatch/courier/profiles/{Id}/availability HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CourierAvailabilityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Availability>
    <Closed>false</Closed>
    <InArea>false</InArea>
    <Windows>
      <CourierEngine.Window>
        <Asap>false</Asap>
        <DayIx>0</DayIx>
        <EndMin>0</EndMin>
        <Id>String</Id>
        <Label>String</Label>
        <Levels>
          <CourierEngine.LevelOffer>
            <Code>String</Code>
            <Name>String</Name>
            <Ok>false</Ok>
            <Promise>String</Promise>
            <Surcharge>0</Surcharge>
            <Why>String</Why>
          </CourierEngine.LevelOffer>
        </Levels>
        <StartMin>0</StartMin>
      </CourierEngine.Window>
    </Windows>
    <ZipChecked>false</ZipChecked>
  </Availability>
  <Date>String</Date>
  <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>
</CourierAvailabilityResponse>