| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/queue/calendar/{LocationId} |
|---|
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 BranchCalendarHours:
date: Optional[str] = None
opens: Optional[str] = None
closes: Optional[str] = None
closed: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchCalendarBranch:
id: Optional[str] = None
name: Optional[str] = None
street: Optional[str] = None
time_zone: Optional[str] = None
windows: int = 0
hours: List[BranchCalendarHours] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchCalendarLine:
id: Optional[str] = None
name: Optional[str] = None
minutes: int = 0
color: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchCalendarCustomer:
contact_id: int = 0
contact_guid: Optional[str] = None
name: Optional[str] = None
phone: Optional[str] = None
email: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchCalendarServiceItem:
line_id: Optional[str] = None
name: Optional[str] = None
minutes: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchCalendarStatus:
state: Optional[str] = None
ticket_label: Optional[str] = None
window: Optional[str] = None
arrived_at: Optional[datetime.datetime] = None
called_at: Optional[datetime.datetime] = None
served_at: Optional[datetime.datetime] = None
no_show_at: Optional[datetime.datetime] = None
cancelled_at: Optional[datetime.datetime] = None
cancelled_by: Optional[str] = None
source: Optional[str] = None
can_check_in: bool = False
can_no_show: bool = False
can_reopen: bool = False
can_change: bool = False
can_cancel: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchCalendarPaperwork:
asks_questionnaire: bool = False
asks_upload: bool = False
submitted: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchCalendarEvent:
calendar_event_id: int = 0
kind: Optional[str] = None
title: Optional[str] = None
start_local: datetime.datetime = datetime.datetime(1, 1, 1)
end_local: Optional[datetime.datetime] = None
all_day: bool = False
description: Optional[str] = None
customer: Optional[BranchCalendarCustomer] = None
services: List[BranchCalendarServiceItem] = field(default_factory=list)
status: Optional[BranchCalendarStatus] = None
check_in_id: Optional[str] = None
paperwork: Optional[BranchCalendarPaperwork] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchCalendarStaffHour:
date: Optional[str] = None
hour: int = 0
windows: Decimal = decimal.Decimal(0)
source: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchCalendarWeekdayHour:
weekday: int = 0
hour: int = 0
windows: Decimal = decimal.Decimal(0)
days: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchCalendarHourMean:
hour: int = 0
windows: Decimal = decimal.Decimal(0)
days: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchCalendarHistory:
by_weekday_hour: List[BranchCalendarWeekdayHour] = field(default_factory=list)
by_hour: List[BranchCalendarHourMean] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchCalendarResponse:
response_status: Optional[ResponseStatus] = None
branch: Optional[BranchCalendarBranch] = None
lines: List[BranchCalendarLine] = field(default_factory=list)
events: List[BranchCalendarEvent] = field(default_factory=list)
staffing: List[BranchCalendarStaffHour] = field(default_factory=list)
history: Optional[BranchCalendarHistory] = None
color_by_service: bool = False
server_now_local: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchCalendarRequest:
location_id: Optional[str] = None
from_: Optional[datetime.datetime] = field(metadata=config(field_name='from'), default=None)
to: Optional[datetime.datetime] = None
include_cancelled: bool = False
Python BranchCalendarRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/queue/calendar/{LocationId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Branch":{"Id":"00000000000000000000000000000000","Name":"String","Street":"String","TimeZone":"String","Windows":0,"Hours":[{"Date":"String","Opens":"String","Closes":"String","Closed":false}]},"Lines":[{"Id":"00000000000000000000000000000000","Name":"String","Minutes":0,"Color":"String"}],"Events":[{"CalendarEventId":0,"Kind":"String","Title":"String","StartLocal":"0001-01-01T00:00:00.0000000","EndLocal":"0001-01-01T00:00:00.0000000","AllDay":false,"Description":"String","Customer":{"ContactId":0,"ContactGuid":"00000000000000000000000000000000","Name":"String","Phone":"String","Email":"String"},"Services":[{"LineId":"00000000000000000000000000000000","Name":"String","Minutes":0}],"Status":{"State":"String","TicketLabel":"String","Window":"String","ArrivedAt":"0001-01-01T00:00:00.0000000","CalledAt":"0001-01-01T00:00:00.0000000","ServedAt":"0001-01-01T00:00:00.0000000","NoShowAt":"0001-01-01T00:00:00.0000000","CancelledAt":"0001-01-01T00:00:00.0000000","CancelledBy":"String","Source":"String","CanCheckIn":false,"CanNoShow":false,"CanReopen":false,"CanChange":false,"CanCancel":false},"CheckInId":"00000000000000000000000000000000","Paperwork":{"AsksQuestionnaire":false,"AsksUpload":false,"Submitted":false}}],"Staffing":[{"Date":"String","Hour":0,"Windows":0,"Source":"String"}],"History":{"ByWeekdayHour":[{"Weekday":0,"Hour":0,"Windows":0,"Days":0}],"ByHour":[{"Hour":0,"Windows":0,"Days":0}]},"ColorByService":false,"ServerNowLocal":"0001-01-01T00:00:00.0000000"}