Trendsic Platform Service

<back to all web services

BranchCalendarRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
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 .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/queue/calendar/{LocationId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<BranchCalendarResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Branch>
    <Hours>
      <BranchCalendarHours>
        <Closed>false</Closed>
        <Closes>String</Closes>
        <Date>String</Date>
        <Opens>String</Opens>
      </BranchCalendarHours>
    </Hours>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <Name>String</Name>
    <Street>String</Street>
    <TimeZone>String</TimeZone>
    <Windows>0</Windows>
  </Branch>
  <ColorByService>false</ColorByService>
  <Events>
    <BranchCalendarEvent>
      <AllDay>false</AllDay>
      <CalendarEventId>0</CalendarEventId>
      <CheckInId>00000000-0000-0000-0000-000000000000</CheckInId>
      <Customer>
        <ContactGuid>00000000-0000-0000-0000-000000000000</ContactGuid>
        <ContactId>0</ContactId>
        <Email>String</Email>
        <Name>String</Name>
        <Phone>String</Phone>
      </Customer>
      <Description>String</Description>
      <EndLocal>0001-01-01T00:00:00</EndLocal>
      <Kind>String</Kind>
      <Paperwork>
        <AsksQuestionnaire>false</AsksQuestionnaire>
        <AsksUpload>false</AsksUpload>
        <Submitted>false</Submitted>
      </Paperwork>
      <Services>
        <BranchCalendarServiceItem>
          <LineId>00000000-0000-0000-0000-000000000000</LineId>
          <Minutes>0</Minutes>
          <Name>String</Name>
        </BranchCalendarServiceItem>
      </Services>
      <StartLocal>0001-01-01T00:00:00</StartLocal>
      <Status>
        <ArrivedAt>0001-01-01T00:00:00</ArrivedAt>
        <CalledAt>0001-01-01T00:00:00</CalledAt>
        <CanCancel>false</CanCancel>
        <CanChange>false</CanChange>
        <CanCheckIn>false</CanCheckIn>
        <CanNoShow>false</CanNoShow>
        <CanReopen>false</CanReopen>
        <CancelledAt>0001-01-01T00:00:00</CancelledAt>
        <CancelledBy>String</CancelledBy>
        <NoShowAt>0001-01-01T00:00:00</NoShowAt>
        <ServedAt>0001-01-01T00:00:00</ServedAt>
        <Source>String</Source>
        <State>String</State>
        <TicketLabel>String</TicketLabel>
        <Window>String</Window>
      </Status>
      <Title>String</Title>
    </BranchCalendarEvent>
  </Events>
  <History>
    <ByHour>
      <BranchCalendarHourMean>
        <Days>0</Days>
        <Hour>0</Hour>
        <Windows>0</Windows>
      </BranchCalendarHourMean>
    </ByHour>
    <ByWeekdayHour>
      <BranchCalendarWeekdayHour>
        <Days>0</Days>
        <Hour>0</Hour>
        <Weekday>0</Weekday>
        <Windows>0</Windows>
      </BranchCalendarWeekdayHour>
    </ByWeekdayHour>
  </History>
  <Lines>
    <BranchCalendarLine>
      <Color>String</Color>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <Minutes>0</Minutes>
      <Name>String</Name>
    </BranchCalendarLine>
  </Lines>
  <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>
  <ServerNowLocal>0001-01-01T00:00:00</ServerNowLocal>
  <Staffing>
    <BranchCalendarStaffHour>
      <Date>String</Date>
      <Hour>0</Hour>
      <Source>String</Source>
      <Windows>0</Windows>
    </BranchCalendarStaffHour>
  </Staffing>
</BranchCalendarResponse>