Trendsic Platform Service

<back to all web services

LobbyChimeRequest

Requires Authentication
The following routes are available for this service:
POST,DELETE,OPTIONS/v1/queue/lobby-settings/{LocationId}/chime
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type LobbySettings() = 
        member val LocationId:Guid = new Guid() with get,set
        member val WaitSource:String = null with get,set
        member val MonitorChime:String = null with get,set
        member val HasUploadedChime:Boolean = new Boolean() with get,set
        member val ChimeUrl:String = null with get,set
        member val MonitorVolume:Int32 = new Int32() with get,set
        member val MonitorAnnounce:Boolean = new Boolean() with get,set
        member val MonitorAnnounceTemplate:String = null with get,set
        member val MonitorVoice:String = null with get,set
        member val MonitorVoiceRate:Decimal = new Decimal() with get,set
        member val MonitorRepeatAfterSec:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val MonitorTicketOnly:Boolean = new Boolean() with get,set
        member val LobbyZoneMode:String = null with get,set
        member val LobbyTakeoverEveryMin:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LobbyTakeoverSec:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LobbyIdleScreen:Boolean = new Boolean() with get,set
        member val TimeZone:String = null with get,set

    [<AllowNullLiteral>]
    type LobbyChimeOption() = 
        member val Key:String = null with get,set
        member val Label:String = null with get,set
        member val Url:String = null with get,set

    [<AllowNullLiteral>]
    type LobbySettingsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Settings:LobbySettings = null with get,set
        member val Chimes:ResizeArray<LobbyChimeOption> = new ResizeArray<LobbyChimeOption>() with get,set

    [<AllowNullLiteral>]
    type LobbyChimeRequest() = 
        member val LocationId:Guid = new Guid() with get,set

F# LobbyChimeRequest 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.

POST /v1/queue/lobby-settings/{LocationId}/chime HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	LocationId: 00000000000000000000000000000000
}
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
		}
	]
}