| POST,DELETE,OPTIONS | /v1/queue/lobby-settings/{LocationId}/chime |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LocationId | path | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Settings | form | LobbySettings | No | |
| Chimes | form | List<LobbyChimeOption> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LocationId | form | Guid | No | |
| WaitSource | form | string | No | |
| MonitorChime | form | string | No | |
| HasUploadedChime | form | bool | No | |
| ChimeUrl | form | string | No | |
| MonitorVolume | form | int | No | |
| MonitorAnnounce | form | bool | No | |
| MonitorAnnounceTemplate | form | string | No | |
| MonitorVoice | form | string | No | |
| MonitorVoiceRate | form | decimal | No | |
| MonitorRepeatAfterSec | form | int? | No | |
| MonitorTicketOnly | form | bool | No | |
| LobbyZoneMode | form | string | No | |
| LobbyTakeoverEveryMin | form | int? | No | |
| LobbyTakeoverSec | form | int? | No | |
| LobbyIdleScreen | form | bool | No | |
| TimeZone | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | form | string | No | |
| Label | form | string | No | |
| Url | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/queue/lobby-settings/{LocationId}/chime HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
LocationId: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
]
}