| GET | /v1/CustomersInLine | ||
|---|---|---|---|
| GET | /v1/CustomersInLine/{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 PaperworkAsks:
questionnaire: bool = False
upload: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerInLineObject:
checkin_id: Optional[str] = None
visit_key: Optional[str] = None
name: Optional[str] = None
say_name_as: Optional[str] = None
line: Optional[str] = None
description: Optional[str] = None
service_id: Optional[str] = None
status: int = 0
sign_in_time: datetime.datetime = datetime.datetime(1, 1, 1)
adjusted_sign_in_time: datetime.datetime = datetime.datetime(1, 1, 1)
arrived_time: Optional[datetime.datetime] = None
send_reminders: bool = False
called_time: Optional[datetime.datetime] = None
ticket_label: Optional[str] = None
station_id: Optional[str] = None
station_name: Optional[str] = None
id: Optional[str] = None
full_name: Optional[str] = None
task_time: Optional[int] = None
completed: Optional[bool] = None
completed_time: Optional[datetime.datetime] = None
employee_id: Optional[str] = None
employee: Optional[str] = None
questionnaire_submitted: Optional[bool] = None
hold_reason: Optional[str] = None
hold_expected_utc: Optional[datetime.datetime] = None
returned_time: Optional[datetime.datetime] = None
contact_id: Optional[int] = None
mobile_phone: Optional[str] = None
source: Optional[str] = None
last_moved_from: Optional[str] = None
last_moved_utc: Optional[datetime.datetime] = None
priority_time: Optional[datetime.datetime] = None
hold_by_name: Optional[str] = None
hold_by_station_name: Optional[str] = None
hold_since_utc: Optional[datetime.datetime] = None
ticket_no: Optional[int] = None
note_count: Optional[int] = None
has_carry_note: Optional[bool] = None
carry_note_by: Optional[str] = None
carry_note_at_utc: Optional[datetime.datetime] = None
paperwork_asks: Optional[PaperworkAsks] = None
document_count: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LobbySettings:
location_id: Optional[str] = None
wait_source: Optional[str] = None
monitor_chime: Optional[str] = None
has_uploaded_chime: bool = False
chime_url: Optional[str] = None
monitor_volume: int = 0
monitor_announce: bool = False
monitor_announce_template: Optional[str] = None
monitor_voice: Optional[str] = None
monitor_voice_lang: Optional[str] = None
monitor_voice_rate: Decimal = decimal.Decimal(0)
monitor_repeat_after_sec: Optional[int] = None
monitor_ticket_only: bool = False
lobby_zone_mode: Optional[str] = None
lobby_takeover_every_min: Optional[int] = None
lobby_takeover_sec: Optional[int] = None
lobby_idle_screen: bool = False
time_zone: Optional[str] = None
monitor_show_services: Optional[bool] = None
lobby_tv_count: Optional[int] = None
ticket_prefix: Optional[str] = None
lobby_density: Optional[str] = None
lobby_idle_mode: Optional[str] = None
lobby_idle_content_id: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StationSessionView:
session_id: Optional[str] = None
location_id: Optional[str] = None
station_id: Optional[str] = None
station_name: Optional[str] = None
employee_id: Optional[str] = None
employee_name: Optional[str] = None
signed_in_utc: datetime.datetime = datetime.datetime(1, 1, 1)
last_seen_utc: datetime.datetime = datetime.datetime(1, 1, 1)
paused_since_utc: Optional[datetime.datetime] = None
pause_reason: Optional[str] = None
home_branch_id: Optional[str] = None
home_branch_name: Optional[str] = None
is_mine: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomersInLineResponse:
response_status: Optional[ResponseStatus] = None
customers: List[CustomerInLineObject] = field(default_factory=list)
location_name: Optional[str] = None
monitor_show_services: Optional[bool] = None
lobby: Optional[LobbySettings] = None
workspace_name: Optional[str] = None
station_term: Optional[str] = None
sessions: List[StationSessionView] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomersInLine:
api_key: Optional[str] = None
location_id: Optional[str] = None
client_is_loading: bool = False
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/CustomersInLine HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CustomersInLineResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Customers>
<CustomerInLineObject>
<AdjustedSignInTime>0001-01-01T00:00:00</AdjustedSignInTime>
<ArrivedTime>0001-01-01T00:00:00</ArrivedTime>
<CalledTime>0001-01-01T00:00:00</CalledTime>
<CarryNoteAtUtc>0001-01-01T00:00:00</CarryNoteAtUtc>
<CarryNoteBy>String</CarryNoteBy>
<CheckinId>00000000-0000-0000-0000-000000000000</CheckinId>
<Completed>false</Completed>
<CompletedTime>0001-01-01T00:00:00</CompletedTime>
<ContactId>0</ContactId>
<Description>String</Description>
<DocumentCount>0</DocumentCount>
<Employee>String</Employee>
<EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
<FullName>String</FullName>
<HasCarryNote>false</HasCarryNote>
<HoldByName>String</HoldByName>
<HoldByStationName>String</HoldByStationName>
<HoldExpectedUtc>0001-01-01T00:00:00</HoldExpectedUtc>
<HoldReason>String</HoldReason>
<HoldSinceUtc>0001-01-01T00:00:00</HoldSinceUtc>
<Id>00000000-0000-0000-0000-000000000000</Id>
<LastMovedFrom>String</LastMovedFrom>
<LastMovedUtc>0001-01-01T00:00:00</LastMovedUtc>
<Line>String</Line>
<MobilePhone>String</MobilePhone>
<Name>String</Name>
<NoteCount>0</NoteCount>
<PaperworkAsks>
<Questionnaire>false</Questionnaire>
<Upload>false</Upload>
</PaperworkAsks>
<PriorityTime>0001-01-01T00:00:00</PriorityTime>
<QuestionnaireSubmitted>false</QuestionnaireSubmitted>
<ReturnedTime>0001-01-01T00:00:00</ReturnedTime>
<SayNameAs>String</SayNameAs>
<SendReminders>false</SendReminders>
<ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
<SignInTime>0001-01-01T00:00:00</SignInTime>
<Source>String</Source>
<StationId>00000000-0000-0000-0000-000000000000</StationId>
<StationName>String</StationName>
<Status>0</Status>
<TaskTime>0</TaskTime>
<TicketLabel>String</TicketLabel>
<TicketNo>0</TicketNo>
<VisitKey>00000000-0000-0000-0000-000000000000</VisitKey>
</CustomerInLineObject>
</Customers>
<Lobby>
<ChimeUrl>String</ChimeUrl>
<HasUploadedChime>false</HasUploadedChime>
<LobbyDensity>String</LobbyDensity>
<LobbyIdleContentId>0</LobbyIdleContentId>
<LobbyIdleMode>String</LobbyIdleMode>
<LobbyIdleScreen>false</LobbyIdleScreen>
<LobbyTakeoverEveryMin>0</LobbyTakeoverEveryMin>
<LobbyTakeoverSec>0</LobbyTakeoverSec>
<LobbyTvCount>0</LobbyTvCount>
<LobbyZoneMode>String</LobbyZoneMode>
<LocationId>00000000-0000-0000-0000-000000000000</LocationId>
<MonitorAnnounce>false</MonitorAnnounce>
<MonitorAnnounceTemplate>String</MonitorAnnounceTemplate>
<MonitorChime>String</MonitorChime>
<MonitorRepeatAfterSec>0</MonitorRepeatAfterSec>
<MonitorShowServices>false</MonitorShowServices>
<MonitorTicketOnly>false</MonitorTicketOnly>
<MonitorVoice>String</MonitorVoice>
<MonitorVoiceLang>String</MonitorVoiceLang>
<MonitorVoiceRate>0</MonitorVoiceRate>
<MonitorVolume>0</MonitorVolume>
<TicketPrefix>String</TicketPrefix>
<TimeZone>String</TimeZone>
<WaitSource>String</WaitSource>
</Lobby>
<LocationName>String</LocationName>
<MonitorShowServices>false</MonitorShowServices>
<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>
<Sessions>
<StationSessionView>
<EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
<EmployeeName>String</EmployeeName>
<HomeBranchId>00000000-0000-0000-0000-000000000000</HomeBranchId>
<HomeBranchName>String</HomeBranchName>
<IsMine>false</IsMine>
<LastSeenUtc>0001-01-01T00:00:00</LastSeenUtc>
<LocationId>00000000-0000-0000-0000-000000000000</LocationId>
<PauseReason>String</PauseReason>
<PausedSinceUtc>0001-01-01T00:00:00</PausedSinceUtc>
<SessionId>00000000-0000-0000-0000-000000000000</SessionId>
<SignedInUtc>0001-01-01T00:00:00</SignedInUtc>
<StationId>00000000-0000-0000-0000-000000000000</StationId>
<StationName>String</StationName>
</StationSessionView>
</Sessions>
<StationTerm>String</StationTerm>
<WorkspaceName>String</WorkspaceName>
</CustomersInLineResponse>