Trendsic Platform Service

LobbySettingsRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
GET,PUT,OPTIONS	/v1/queue/lobby-settings/{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 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_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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LobbyChimeOption:
    key: Optional[str] = None
    label: Optional[str] = None
    url: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LobbySettingsResponse:
    response_status: Optional[ResponseStatus] = None
    settings: Optional[LobbySettings] = None
    chimes: List[LobbyChimeOption] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LobbySettingsRequest:
    location_id: Optional[str] = None
    wait_source: Optional[str] = None
    monitor_chime: Optional[str] = None
    monitor_volume: Optional[int] = None
    monitor_announce: Optional[bool] = None
    monitor_announce_template: Optional[str] = None
    monitor_voice: Optional[str] = None
    monitor_voice_rate: Optional[Decimal] = None
    monitor_repeat_after_sec: Optional[int] = None
    monitor_ticket_only: Optional[bool] = None
    lobby_zone_mode: Optional[str] = None
    lobby_takeover_every_min: Optional[int] = None
    lobby_takeover_sec: Optional[int] = None
    lobby_idle_screen: Optional[bool] = None

Python LobbySettingsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /v1/queue/lobby-settings/{LocationId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"LocationId":"00000000000000000000000000000000","WaitSource":"String","MonitorChime":"String","MonitorVolume":0,"MonitorAnnounce":false,"MonitorAnnounceTemplate":"String","MonitorVoice":"String","MonitorVoiceRate":0,"MonitorRepeatAfterSec":0,"MonitorTicketOnly":false,"LobbyZoneMode":"String","LobbyTakeoverEveryMin":0,"LobbyTakeoverSec":0,"LobbyIdleScreen":false}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Settings":{"LocationId":"00000000000000000000000000000000","WaitSource":"String","MonitorChime":"String","HasUploadedChime":false,"ChimeUrl":"String","MonitorVolume":0,"MonitorAnnounce":false,"MonitorAnnounceTemplate":"String","MonitorVoice":"String","MonitorVoiceRate":0,"MonitorRepeatAfterSec":0,"MonitorTicketOnly":false,"LobbyZoneMode":"String","LobbyTakeoverEveryMin":0,"LobbyTakeoverSec":0,"LobbyIdleScreen":false,"TimeZone":"String"},"Chimes":[{"Key":"String","Label":"String","Url":"String"}]}