| 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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Availability:
{
InArea: False,
ZipChecked: False,
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
}
]
}
]
},
Date: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}