Trendsic Platform Service

<back to all web services

LobbyChimeRequest

Requires Authentication
The following routes are available for this service:
POST,DELETE,OPTIONS/v1/queue/lobby-settings/{LocationId}/chime
LobbyChimeRequest Parameters:
NameParameterData TypeRequiredDescription
LocationIdpathGuidNo
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 .jsv suffix or ?format=jsv

HTTP + 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
		}
	]
}