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
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class LobbyChimeRequest
{
    open var LocationId:UUID? = null
}

open class LobbySettingsResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Settings:LobbySettings? = null
    open var Chimes:ArrayList<LobbyChimeOption> = ArrayList<LobbyChimeOption>()
}

open class LobbySettings
{
    open var LocationId:UUID? = null
    open var WaitSource:String? = null
    open var MonitorChime:String? = null
    open var HasUploadedChime:Boolean? = null
    open var ChimeUrl:String? = null
    open var MonitorVolume:Int? = null
    open var MonitorAnnounce:Boolean? = null
    open var MonitorAnnounceTemplate:String? = null
    open var MonitorVoice:String? = null
    open var MonitorVoiceRate:BigDecimal? = null
    open var MonitorRepeatAfterSec:Int? = null
    open var MonitorTicketOnly:Boolean? = null
    open var LobbyZoneMode:String? = null
    open var LobbyTakeoverEveryMin:Int? = null
    open var LobbyTakeoverSec:Int? = null
    open var LobbyIdleScreen:Boolean? = null
    open var TimeZone:String? = null
}

open class LobbyChimeOption
{
    open var Key:String? = null
    open var Label:String? = null
    open var Url:String? = null
}

Kotlin LobbyChimeRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"LocationId":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}]}