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}

**LobbySettingsRequest** Parameters:
Name	Parameter	Data Type	Required
LocationId	path	Guid	No
WaitSource	body	string	No
MonitorChime	body	string	No
MonitorVolume	body	int?	No
MonitorAnnounce	body	bool?	No
MonitorAnnounceTemplate	body	string	No
MonitorVoice	body	string	No
MonitorVoiceRate	body	decimal?	No
MonitorRepeatAfterSec	body	int?	No
MonitorTicketOnly	body	bool?	No
LobbyZoneMode	body	string	No
LobbyTakeoverEveryMin	body	int?	No
LobbyTakeoverSec	body	int?	No
LobbyIdleScreen	body	bool?	No

**LobbySettingsResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
Settings	form	LobbySettings	No
Chimes	form	List<LobbyChimeOption>	No

**LobbySettings** Parameters:
Name	Parameter	Data Type	Required
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

**LobbyChimeOption** Parameters:
Name	Parameter	Data Type	Required
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

HTTP + JSV

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/jsv
Content-Type: text/jsv
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/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
		}
	]
}