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}

import Foundation
import ServiceStack

public class LobbySettingsRequest : Codable
{
    public var locationId:String
    public var waitSource:String
    public var monitorChime:String
    public var monitorVolume:Int?
    public var monitorAnnounce:Bool?
    public var monitorAnnounceTemplate:String
    public var monitorVoice:String
    public var monitorVoiceRate:Double?
    public var monitorRepeatAfterSec:Int?
    public var monitorTicketOnly:Bool?
    public var lobbyZoneMode:String
    public var lobbyTakeoverEveryMin:Int?
    public var lobbyTakeoverSec:Int?
    public var lobbyIdleScreen:Bool?

    required public init(){}
}

public class LobbySettingsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var settings:LobbySettings
    public var chimes:[LobbyChimeOption] = []

    required public init(){}
}

public class LobbySettings : Codable
{
    public var locationId:String
    public var waitSource:String
    public var monitorChime:String
    public var hasUploadedChime:Bool
    public var chimeUrl:String
    public var monitorVolume:Int
    public var monitorAnnounce:Bool
    public var monitorAnnounceTemplate:String
    public var monitorVoice:String
    public var monitorVoiceRate:Double
    public var monitorRepeatAfterSec:Int?
    public var monitorTicketOnly:Bool
    public var lobbyZoneMode:String
    public var lobbyTakeoverEveryMin:Int?
    public var lobbyTakeoverSec:Int?
    public var lobbyIdleScreen:Bool
    public var timeZone:String

    required public init(){}
}

public class LobbyChimeOption : Codable
{
    public var key:String
    public var label:String
    public var url:String

    required public init(){}
}

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