Trendsic Platform Service

<back to all web services

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}
LobbySettingsRequest Parameters:
NameParameterData TypeRequiredDescription
LocationIdpathGuidNo
WaitSourcebodystringNo
MonitorChimebodystringNo
MonitorVolumebodyint?No
MonitorAnnouncebodybool?No
MonitorAnnounceTemplatebodystringNo
MonitorVoicebodystringNo
MonitorVoiceRatebodydecimal?No
MonitorRepeatAfterSecbodyint?No
MonitorTicketOnlybodybool?No
LobbyZoneModebodystringNo
LobbyTakeoverEveryMinbodyint?No
LobbyTakeoverSecbodyint?No
LobbyIdleScreenbodybool?No
LobbySettingsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
SettingsformLobbySettingsNo
ChimesformList<LobbyChimeOption>No
LobbySettings Parameters:
NameParameterData TypeRequiredDescription
LocationIdformGuidNo
WaitSourceformstringNo
MonitorChimeformstringNo
HasUploadedChimeformboolNo
ChimeUrlformstringNo
MonitorVolumeformintNo
MonitorAnnounceformboolNo
MonitorAnnounceTemplateformstringNo
MonitorVoiceformstringNo
MonitorVoiceRateformdecimalNo
MonitorRepeatAfterSecformint?No
MonitorTicketOnlyformboolNo
LobbyZoneModeformstringNo
LobbyTakeoverEveryMinformint?No
LobbyTakeoverSecformint?No
LobbyIdleScreenformboolNo
TimeZoneformstringNo
LobbyChimeOption Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
LabelformstringNo
UrlformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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"}]}