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}

"use strict";
export class LobbySettings {
    /** @param {{LocationId?:string,WaitSource?:string,MonitorChime?:string,HasUploadedChime?:boolean,ChimeUrl?:string,MonitorVolume?:number,MonitorAnnounce?:boolean,MonitorAnnounceTemplate?:string,MonitorVoice?:string,MonitorVoiceRate?:number,MonitorRepeatAfterSec?:number,MonitorTicketOnly?:boolean,LobbyZoneMode?:string,LobbyTakeoverEveryMin?:number,LobbyTakeoverSec?:number,LobbyIdleScreen?:boolean,TimeZone?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LocationId;
    /** @type {string} */
    WaitSource;
    /** @type {string} */
    MonitorChime;
    /** @type {boolean} */
    HasUploadedChime;
    /** @type {string} */
    ChimeUrl;
    /** @type {number} */
    MonitorVolume;
    /** @type {boolean} */
    MonitorAnnounce;
    /** @type {string} */
    MonitorAnnounceTemplate;
    /** @type {string} */
    MonitorVoice;
    /** @type {number} */
    MonitorVoiceRate;
    /** @type {?number} */
    MonitorRepeatAfterSec;
    /** @type {boolean} */
    MonitorTicketOnly;
    /** @type {string} */
    LobbyZoneMode;
    /** @type {?number} */
    LobbyTakeoverEveryMin;
    /** @type {?number} */
    LobbyTakeoverSec;
    /** @type {boolean} */
    LobbyIdleScreen;
    /** @type {string} */
    TimeZone;
}
export class LobbyChimeOption {
    /** @param {{Key?:string,Label?:string,Url?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Label;
    /** @type {string} */
    Url;
}
export class LobbySettingsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Settings?:LobbySettings,Chimes?:LobbyChimeOption[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {LobbySettings} */
    Settings;
    /** @type {LobbyChimeOption[]} */
    Chimes = [];
}
export class LobbySettingsRequest {
    /** @param {{LocationId?:string,WaitSource?:string,MonitorChime?:string,MonitorVolume?:number,MonitorAnnounce?:boolean,MonitorAnnounceTemplate?:string,MonitorVoice?:string,MonitorVoiceRate?:number,MonitorRepeatAfterSec?:number,MonitorTicketOnly?:boolean,LobbyZoneMode?:string,LobbyTakeoverEveryMin?:number,LobbyTakeoverSec?:number,LobbyIdleScreen?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LocationId;
    /** @type {string} */
    WaitSource;
    /** @type {string} */
    MonitorChime;
    /** @type {?number} */
    MonitorVolume;
    /** @type {?boolean} */
    MonitorAnnounce;
    /** @type {string} */
    MonitorAnnounceTemplate;
    /** @type {string} */
    MonitorVoice;
    /** @type {?number} */
    MonitorVoiceRate;
    /** @type {?number} */
    MonitorRepeatAfterSec;
    /** @type {?boolean} */
    MonitorTicketOnly;
    /** @type {string} */
    LobbyZoneMode;
    /** @type {?number} */
    LobbyTakeoverEveryMin;
    /** @type {?number} */
    LobbyTakeoverSec;
    /** @type {?boolean} */
    LobbyIdleScreen;
}

JavaScript LobbySettingsRequest DTOs

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