Trendsic Platform Service

<back to all web services

BranchApptSlotsRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/queue/appointments/slots
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 BranchApptSlot:
    start_local: Optional[str] = None
    booked: int = 0
    capacity: int = 0
    open: int = 0
    full: bool = False
    past: bool = False
    fits: bool = False
    reason: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchApptSlotsResponse:
    response_status: Optional[ResponseStatus] = None
    date: Optional[str] = None
    timeslot_minutes: int = 0
    slot_minutes: int = 0
    capacity: int = 0
    online_paused: bool = False
    slots: List[BranchApptSlot] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchApptSlotsRequest:
    location_id: Optional[str] = None
    date: Optional[str] = None
    line_ids: Optional[str] = None
    exclude_check_in_id: Optional[str] = None

Python BranchApptSlotsRequest 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/appointments/slots HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BranchApptSlotsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Capacity>0</Capacity>
  <Date>String</Date>
  <OnlinePaused>false</OnlinePaused>
  <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>
  <SlotMinutes>0</SlotMinutes>
  <Slots>
    <BranchApptSlot>
      <Booked>0</Booked>
      <Capacity>0</Capacity>
      <Fits>false</Fits>
      <Full>false</Full>
      <Open>0</Open>
      <Past>false</Past>
      <Reason>String</Reason>
      <StartLocal>String</StartLocal>
    </BranchApptSlot>
  </Slots>
  <TimeslotMinutes>0</TimeslotMinutes>
</BranchApptSlotsResponse>