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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class LobbyChimeOption
            Public Overridable Property Key As String
            Public Overridable Property Label As String
            Public Overridable Property Url As String
        End Class

        Public Partial Class LobbyChimeRequest
            Public Overridable Property LocationId As Guid
        End Class

        Public Partial Class LobbySettings
            Public Overridable Property LocationId As Guid
            Public Overridable Property WaitSource As String
            Public Overridable Property MonitorChime As String
            Public Overridable Property HasUploadedChime As Boolean
            Public Overridable Property ChimeUrl As String
            Public Overridable Property MonitorVolume As Integer
            Public Overridable Property MonitorAnnounce As Boolean
            Public Overridable Property MonitorAnnounceTemplate As String
            Public Overridable Property MonitorVoice As String
            Public Overridable Property MonitorVoiceRate As Decimal
            Public Overridable Property MonitorRepeatAfterSec As Integer?
            Public Overridable Property MonitorTicketOnly As Boolean
            Public Overridable Property LobbyZoneMode As String
            Public Overridable Property LobbyTakeoverEveryMin As Integer?
            Public Overridable Property LobbyTakeoverSec As Integer?
            Public Overridable Property LobbyIdleScreen As Boolean
            Public Overridable Property TimeZone As String
        End Class

        Public Partial Class LobbySettingsResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Settings As LobbySettings
            Public Overridable Property Chimes As List(Of LobbyChimeOption) = New List(Of LobbyChimeOption)
        End Class
    End Namespace
End Namespace

VB.NET LobbyChimeRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

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