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.*;

public class dtos
{

    public static class LobbyChimeRequest
    {
        public UUID LocationId = null;
        
        public UUID getLocationId() { return LocationId; }
        public LobbyChimeRequest setLocationId(UUID value) { this.LocationId = 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 LobbyChimeRequest DTOs

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

HTTP + XML

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

<LobbyChimeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
</LobbyChimeRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LobbySettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Chimes>
    <LobbyChimeOption>
      <Key>String</Key>
      <Label>String</Label>
      <Url>String</Url>
    </LobbyChimeOption>
  </Chimes>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Settings>
    <ChimeUrl>String</ChimeUrl>
    <HasUploadedChime>false</HasUploadedChime>
    <LobbyIdleScreen>false</LobbyIdleScreen>
    <LobbyTakeoverEveryMin>0</LobbyTakeoverEveryMin>
    <LobbyTakeoverSec>0</LobbyTakeoverSec>
    <LobbyZoneMode>String</LobbyZoneMode>
    <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
    <MonitorAnnounce>false</MonitorAnnounce>
    <MonitorAnnounceTemplate>String</MonitorAnnounceTemplate>
    <MonitorChime>String</MonitorChime>
    <MonitorRepeatAfterSec>0</MonitorRepeatAfterSec>
    <MonitorTicketOnly>false</MonitorTicketOnly>
    <MonitorVoice>String</MonitorVoice>
    <MonitorVoiceRate>0</MonitorVoiceRate>
    <MonitorVolume>0</MonitorVolume>
    <TimeZone>String</TimeZone>
    <WaitSource>String</WaitSource>
  </Settings>
</LobbySettingsResponse>