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}

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class LobbyChimeOption
    {
        public virtual string Key { get; set; }
        public virtual string Label { get; set; }
        public virtual string Url { get; set; }
    }

    public partial class LobbySettings
    {
        public virtual Guid LocationId { get; set; }
        public virtual string WaitSource { get; set; }
        public virtual string MonitorChime { get; set; }
        public virtual bool HasUploadedChime { get; set; }
        public virtual string ChimeUrl { get; set; }
        public virtual int MonitorVolume { get; set; }
        public virtual bool MonitorAnnounce { get; set; }
        public virtual string MonitorAnnounceTemplate { get; set; }
        public virtual string MonitorVoice { get; set; }
        public virtual decimal MonitorVoiceRate { get; set; }
        public virtual int? MonitorRepeatAfterSec { get; set; }
        public virtual bool MonitorTicketOnly { get; set; }
        public virtual string LobbyZoneMode { get; set; }
        public virtual int? LobbyTakeoverEveryMin { get; set; }
        public virtual int? LobbyTakeoverSec { get; set; }
        public virtual bool LobbyIdleScreen { get; set; }
        public virtual string TimeZone { get; set; }
    }

    public partial class LobbySettingsRequest
    {
        public virtual Guid LocationId { get; set; }
        public virtual string WaitSource { get; set; }
        public virtual string MonitorChime { get; set; }
        public virtual int? MonitorVolume { get; set; }
        public virtual bool? MonitorAnnounce { get; set; }
        public virtual string MonitorAnnounceTemplate { get; set; }
        public virtual string MonitorVoice { get; set; }
        public virtual decimal? MonitorVoiceRate { get; set; }
        public virtual int? MonitorRepeatAfterSec { get; set; }
        public virtual bool? MonitorTicketOnly { get; set; }
        public virtual string LobbyZoneMode { get; set; }
        public virtual int? LobbyTakeoverEveryMin { get; set; }
        public virtual int? LobbyTakeoverSec { get; set; }
        public virtual bool? LobbyIdleScreen { get; set; }
    }

    public partial class LobbySettingsResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual LobbySettings Settings { get; set; }
        public virtual List<LobbyChimeOption> Chimes { get; set; } = [];
    }

}

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