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}

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 LobbySettingsRequest() = 
        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 MonitorVolume:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val MonitorAnnounce:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val MonitorAnnounceTemplate:String = null with get,set
        member val MonitorVoice:String = null with get,set
        member val MonitorVoiceRate:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val MonitorRepeatAfterSec:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val MonitorTicketOnly:Nullable<Boolean> = new Nullable<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:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# LobbySettingsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
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"}]}