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}

"use strict";
export class LobbySettings {
    /** @param {{LocationId?:string,WaitSource?:string,MonitorChime?:string,HasUploadedChime?:boolean,ChimeUrl?:string,MonitorVolume?:number,MonitorAnnounce?:boolean,MonitorAnnounceTemplate?:string,MonitorVoice?:string,MonitorVoiceRate?:number,MonitorRepeatAfterSec?:number,MonitorTicketOnly?:boolean,LobbyZoneMode?:string,LobbyTakeoverEveryMin?:number,LobbyTakeoverSec?:number,LobbyIdleScreen?:boolean,TimeZone?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LocationId;
    /** @type {string} */
    WaitSource;
    /** @type {string} */
    MonitorChime;
    /** @type {boolean} */
    HasUploadedChime;
    /** @type {string} */
    ChimeUrl;
    /** @type {number} */
    MonitorVolume;
    /** @type {boolean} */
    MonitorAnnounce;
    /** @type {string} */
    MonitorAnnounceTemplate;
    /** @type {string} */
    MonitorVoice;
    /** @type {number} */
    MonitorVoiceRate;
    /** @type {?number} */
    MonitorRepeatAfterSec;
    /** @type {boolean} */
    MonitorTicketOnly;
    /** @type {string} */
    LobbyZoneMode;
    /** @type {?number} */
    LobbyTakeoverEveryMin;
    /** @type {?number} */
    LobbyTakeoverSec;
    /** @type {boolean} */
    LobbyIdleScreen;
    /** @type {string} */
    TimeZone;
}
export class LobbyChimeOption {
    /** @param {{Key?:string,Label?:string,Url?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Label;
    /** @type {string} */
    Url;
}
export class LobbySettingsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Settings?:LobbySettings,Chimes?:LobbyChimeOption[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {LobbySettings} */
    Settings;
    /** @type {LobbyChimeOption[]} */
    Chimes = [];
}
export class LobbySettingsRequest {
    /** @param {{LocationId?:string,WaitSource?:string,MonitorChime?:string,MonitorVolume?:number,MonitorAnnounce?:boolean,MonitorAnnounceTemplate?:string,MonitorVoice?:string,MonitorVoiceRate?:number,MonitorRepeatAfterSec?:number,MonitorTicketOnly?:boolean,LobbyZoneMode?:string,LobbyTakeoverEveryMin?:number,LobbyTakeoverSec?:number,LobbyIdleScreen?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LocationId;
    /** @type {string} */
    WaitSource;
    /** @type {string} */
    MonitorChime;
    /** @type {?number} */
    MonitorVolume;
    /** @type {?boolean} */
    MonitorAnnounce;
    /** @type {string} */
    MonitorAnnounceTemplate;
    /** @type {string} */
    MonitorVoice;
    /** @type {?number} */
    MonitorVoiceRate;
    /** @type {?number} */
    MonitorRepeatAfterSec;
    /** @type {?boolean} */
    MonitorTicketOnly;
    /** @type {string} */
    LobbyZoneMode;
    /** @type {?number} */
    LobbyTakeoverEveryMin;
    /** @type {?number} */
    LobbyTakeoverSec;
    /** @type {?boolean} */
    LobbyIdleScreen;
}

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

PUT /v1/queue/lobby-settings/{LocationId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<LobbySettingsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <WaitSource>String</WaitSource>
</LobbySettingsRequest>

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>