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}


export class LobbySettings
{
    public LocationId: string;
    public WaitSource: string;
    public MonitorChime: string;
    public HasUploadedChime: boolean;
    public ChimeUrl: string;
    public MonitorVolume: number;
    public MonitorAnnounce: boolean;
    public MonitorAnnounceTemplate: string;
    public MonitorVoice: string;
    public MonitorVoiceRate: number;
    public MonitorRepeatAfterSec?: number;
    public MonitorTicketOnly: boolean;
    public LobbyZoneMode: string;
    public LobbyTakeoverEveryMin?: number;
    public LobbyTakeoverSec?: number;
    public LobbyIdleScreen: boolean;
    public TimeZone: string;

    public constructor(init?: Partial<LobbySettings>) { (Object as any).assign(this, init); }
}

export class LobbyChimeOption
{
    public Key: string;
    public Label: string;
    public Url: string;

    public constructor(init?: Partial<LobbyChimeOption>) { (Object as any).assign(this, init); }
}

export class LobbySettingsResponse
{
    public ResponseStatus: ResponseStatus;
    public Settings: LobbySettings;
    public Chimes: LobbyChimeOption[] = [];

    public constructor(init?: Partial<LobbySettingsResponse>) { (Object as any).assign(this, init); }
}

export class LobbySettingsRequest
{
    public LocationId: string;
    public WaitSource: string;
    public MonitorChime: string;
    public MonitorVolume?: number;
    public MonitorAnnounce?: boolean;
    public MonitorAnnounceTemplate: string;
    public MonitorVoice: string;
    public MonitorVoiceRate?: number;
    public MonitorRepeatAfterSec?: number;
    public MonitorTicketOnly?: boolean;
    public LobbyZoneMode: string;
    public LobbyTakeoverEveryMin?: number;
    public LobbyTakeoverSec?: number;
    public LobbyIdleScreen?: boolean;

    public constructor(init?: Partial<LobbySettingsRequest>) { (Object as any).assign(this, init); }
}

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