Trendsic Platform Service

<back to all web services

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

public class dtos
{

    public static class LobbySettingsRequest
    {
        public UUID LocationId = null;
        public String WaitSource = null;
        public String MonitorChime = null;
        public Integer MonitorVolume = null;
        public Boolean MonitorAnnounce = null;
        public String MonitorAnnounceTemplate = null;
        public String MonitorVoice = null;
        public BigDecimal MonitorVoiceRate = null;
        public Integer MonitorRepeatAfterSec = null;
        public Boolean MonitorTicketOnly = null;
        public String LobbyZoneMode = null;
        public Integer LobbyTakeoverEveryMin = null;
        public Integer LobbyTakeoverSec = null;
        public Boolean LobbyIdleScreen = null;
        
        public UUID getLocationId() { return LocationId; }
        public LobbySettingsRequest setLocationId(UUID value) { this.LocationId = value; return this; }
        public String getWaitSource() { return WaitSource; }
        public LobbySettingsRequest setWaitSource(String value) { this.WaitSource = value; return this; }
        public String getMonitorChime() { return MonitorChime; }
        public LobbySettingsRequest setMonitorChime(String value) { this.MonitorChime = value; return this; }
        public Integer getMonitorVolume() { return MonitorVolume; }
        public LobbySettingsRequest setMonitorVolume(Integer value) { this.MonitorVolume = value; return this; }
        public Boolean isMonitorAnnounce() { return MonitorAnnounce; }
        public LobbySettingsRequest setMonitorAnnounce(Boolean value) { this.MonitorAnnounce = value; return this; }
        public String getMonitorAnnounceTemplate() { return MonitorAnnounceTemplate; }
        public LobbySettingsRequest setMonitorAnnounceTemplate(String value) { this.MonitorAnnounceTemplate = value; return this; }
        public String getMonitorVoice() { return MonitorVoice; }
        public LobbySettingsRequest setMonitorVoice(String value) { this.MonitorVoice = value; return this; }
        public BigDecimal getMonitorVoiceRate() { return MonitorVoiceRate; }
        public LobbySettingsRequest setMonitorVoiceRate(BigDecimal value) { this.MonitorVoiceRate = value; return this; }
        public Integer getMonitorRepeatAfterSec() { return MonitorRepeatAfterSec; }
        public LobbySettingsRequest setMonitorRepeatAfterSec(Integer value) { this.MonitorRepeatAfterSec = value; return this; }
        public Boolean isMonitorTicketOnly() { return MonitorTicketOnly; }
        public LobbySettingsRequest setMonitorTicketOnly(Boolean value) { this.MonitorTicketOnly = value; return this; }
        public String getLobbyZoneMode() { return LobbyZoneMode; }
        public LobbySettingsRequest setLobbyZoneMode(String value) { this.LobbyZoneMode = value; return this; }
        public Integer getLobbyTakeoverEveryMin() { return LobbyTakeoverEveryMin; }
        public LobbySettingsRequest setLobbyTakeoverEveryMin(Integer value) { this.LobbyTakeoverEveryMin = value; return this; }
        public Integer getLobbyTakeoverSec() { return LobbyTakeoverSec; }
        public LobbySettingsRequest setLobbyTakeoverSec(Integer value) { this.LobbyTakeoverSec = value; return this; }
        public Boolean isLobbyIdleScreen() { return LobbyIdleScreen; }
        public LobbySettingsRequest setLobbyIdleScreen(Boolean value) { this.LobbyIdleScreen = value; return this; }
    }

    public static class LobbySettingsResponse
    {
        public ResponseStatus ResponseStatus = null;
        public LobbySettings Settings = null;
        public ArrayList<LobbyChimeOption> Chimes = new ArrayList<LobbyChimeOption>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public LobbySettingsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public LobbySettings getSettings() { return Settings; }
        public LobbySettingsResponse setSettings(LobbySettings value) { this.Settings = value; return this; }
        public ArrayList<LobbyChimeOption> getChimes() { return Chimes; }
        public LobbySettingsResponse setChimes(ArrayList<LobbyChimeOption> value) { this.Chimes = value; return this; }
    }

    public static class LobbySettings
    {
        public UUID LocationId = null;
        public String WaitSource = null;
        public String MonitorChime = null;
        public Boolean HasUploadedChime = null;
        public String ChimeUrl = null;
        public Integer MonitorVolume = null;
        public Boolean MonitorAnnounce = null;
        public String MonitorAnnounceTemplate = null;
        public String MonitorVoice = null;
        public BigDecimal MonitorVoiceRate = null;
        public Integer MonitorRepeatAfterSec = null;
        public Boolean MonitorTicketOnly = null;
        public String LobbyZoneMode = null;
        public Integer LobbyTakeoverEveryMin = null;
        public Integer LobbyTakeoverSec = null;
        public Boolean LobbyIdleScreen = null;
        public String TimeZone = null;
        
        public UUID getLocationId() { return LocationId; }
        public LobbySettings setLocationId(UUID value) { this.LocationId = value; return this; }
        public String getWaitSource() { return WaitSource; }
        public LobbySettings setWaitSource(String value) { this.WaitSource = value; return this; }
        public String getMonitorChime() { return MonitorChime; }
        public LobbySettings setMonitorChime(String value) { this.MonitorChime = value; return this; }
        public Boolean isHasUploadedChime() { return HasUploadedChime; }
        public LobbySettings setHasUploadedChime(Boolean value) { this.HasUploadedChime = value; return this; }
        public String getChimeUrl() { return ChimeUrl; }
        public LobbySettings setChimeUrl(String value) { this.ChimeUrl = value; return this; }
        public Integer getMonitorVolume() { return MonitorVolume; }
        public LobbySettings setMonitorVolume(Integer value) { this.MonitorVolume = value; return this; }
        public Boolean isMonitorAnnounce() { return MonitorAnnounce; }
        public LobbySettings setMonitorAnnounce(Boolean value) { this.MonitorAnnounce = value; return this; }
        public String getMonitorAnnounceTemplate() { return MonitorAnnounceTemplate; }
        public LobbySettings setMonitorAnnounceTemplate(String value) { this.MonitorAnnounceTemplate = value; return this; }
        public String getMonitorVoice() { return MonitorVoice; }
        public LobbySettings setMonitorVoice(String value) { this.MonitorVoice = value; return this; }
        public BigDecimal getMonitorVoiceRate() { return MonitorVoiceRate; }
        public LobbySettings setMonitorVoiceRate(BigDecimal value) { this.MonitorVoiceRate = value; return this; }
        public Integer getMonitorRepeatAfterSec() { return MonitorRepeatAfterSec; }
        public LobbySettings setMonitorRepeatAfterSec(Integer value) { this.MonitorRepeatAfterSec = value; return this; }
        public Boolean isMonitorTicketOnly() { return MonitorTicketOnly; }
        public LobbySettings setMonitorTicketOnly(Boolean value) { this.MonitorTicketOnly = value; return this; }
        public String getLobbyZoneMode() { return LobbyZoneMode; }
        public LobbySettings setLobbyZoneMode(String value) { this.LobbyZoneMode = value; return this; }
        public Integer getLobbyTakeoverEveryMin() { return LobbyTakeoverEveryMin; }
        public LobbySettings setLobbyTakeoverEveryMin(Integer value) { this.LobbyTakeoverEveryMin = value; return this; }
        public Integer getLobbyTakeoverSec() { return LobbyTakeoverSec; }
        public LobbySettings setLobbyTakeoverSec(Integer value) { this.LobbyTakeoverSec = value; return this; }
        public Boolean isLobbyIdleScreen() { return LobbyIdleScreen; }
        public LobbySettings setLobbyIdleScreen(Boolean value) { this.LobbyIdleScreen = value; return this; }
        public String getTimeZone() { return TimeZone; }
        public LobbySettings setTimeZone(String value) { this.TimeZone = value; return this; }
    }

    public static class LobbyChimeOption
    {
        public String Key = null;
        public String Label = null;
        public String Url = null;
        
        public String getKey() { return Key; }
        public LobbyChimeOption setKey(String value) { this.Key = value; return this; }
        public String getLabel() { return Label; }
        public LobbyChimeOption setLabel(String value) { this.Label = value; return this; }
        public String getUrl() { return Url; }
        public LobbyChimeOption setUrl(String value) { this.Url = value; return this; }
    }

}

Java LobbySettingsRequest 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.

PUT /v1/queue/lobby-settings/{LocationId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
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: 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"}]}