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 'package:servicestack/servicestack.dart';

class LobbySettings implements IConvertible
{
    String? LocationId;
    String? WaitSource;
    String? MonitorChime;
    bool? HasUploadedChime;
    String? ChimeUrl;
    int? MonitorVolume;
    bool? MonitorAnnounce;
    String? MonitorAnnounceTemplate;
    String? MonitorVoice;
    double? MonitorVoiceRate;
    int? MonitorRepeatAfterSec;
    bool? MonitorTicketOnly;
    String? LobbyZoneMode;
    int? LobbyTakeoverEveryMin;
    int? LobbyTakeoverSec;
    bool? LobbyIdleScreen;
    String? TimeZone;

    LobbySettings({this.LocationId,this.WaitSource,this.MonitorChime,this.HasUploadedChime,this.ChimeUrl,this.MonitorVolume,this.MonitorAnnounce,this.MonitorAnnounceTemplate,this.MonitorVoice,this.MonitorVoiceRate,this.MonitorRepeatAfterSec,this.MonitorTicketOnly,this.LobbyZoneMode,this.LobbyTakeoverEveryMin,this.LobbyTakeoverSec,this.LobbyIdleScreen,this.TimeZone});
    LobbySettings.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        LocationId = json['LocationId'];
        WaitSource = json['WaitSource'];
        MonitorChime = json['MonitorChime'];
        HasUploadedChime = json['HasUploadedChime'];
        ChimeUrl = json['ChimeUrl'];
        MonitorVolume = json['MonitorVolume'];
        MonitorAnnounce = json['MonitorAnnounce'];
        MonitorAnnounceTemplate = json['MonitorAnnounceTemplate'];
        MonitorVoice = json['MonitorVoice'];
        MonitorVoiceRate = JsonConverters.toDouble(json['MonitorVoiceRate']);
        MonitorRepeatAfterSec = json['MonitorRepeatAfterSec'];
        MonitorTicketOnly = json['MonitorTicketOnly'];
        LobbyZoneMode = json['LobbyZoneMode'];
        LobbyTakeoverEveryMin = json['LobbyTakeoverEveryMin'];
        LobbyTakeoverSec = json['LobbyTakeoverSec'];
        LobbyIdleScreen = json['LobbyIdleScreen'];
        TimeZone = json['TimeZone'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'LocationId': LocationId,
        'WaitSource': WaitSource,
        'MonitorChime': MonitorChime,
        'HasUploadedChime': HasUploadedChime,
        'ChimeUrl': ChimeUrl,
        'MonitorVolume': MonitorVolume,
        'MonitorAnnounce': MonitorAnnounce,
        'MonitorAnnounceTemplate': MonitorAnnounceTemplate,
        'MonitorVoice': MonitorVoice,
        'MonitorVoiceRate': MonitorVoiceRate,
        'MonitorRepeatAfterSec': MonitorRepeatAfterSec,
        'MonitorTicketOnly': MonitorTicketOnly,
        'LobbyZoneMode': LobbyZoneMode,
        'LobbyTakeoverEveryMin': LobbyTakeoverEveryMin,
        'LobbyTakeoverSec': LobbyTakeoverSec,
        'LobbyIdleScreen': LobbyIdleScreen,
        'TimeZone': TimeZone
    };

    getTypeName() => "LobbySettings";
    TypeContext? context = _ctx;
}

class LobbyChimeOption implements IConvertible
{
    String? Key;
    String? Label;
    String? Url;

    LobbyChimeOption({this.Key,this.Label,this.Url});
    LobbyChimeOption.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Key = json['Key'];
        Label = json['Label'];
        Url = json['Url'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Key': Key,
        'Label': Label,
        'Url': Url
    };

    getTypeName() => "LobbyChimeOption";
    TypeContext? context = _ctx;
}

class LobbySettingsResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    LobbySettings? Settings;
    List<LobbyChimeOption>? Chimes = [];

    LobbySettingsResponse({this.ResponseStatus,this.Settings,this.Chimes});
    LobbySettingsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        Settings = JsonConverters.fromJson(json['Settings'],'LobbySettings',context!);
        Chimes = JsonConverters.fromJson(json['Chimes'],'List<LobbyChimeOption>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Settings': JsonConverters.toJson(Settings,'LobbySettings',context!),
        'Chimes': JsonConverters.toJson(Chimes,'List<LobbyChimeOption>',context!)
    };

    getTypeName() => "LobbySettingsResponse";
    TypeContext? context = _ctx;
}

class LobbyChimeRequest implements IConvertible
{
    String? LocationId;

    LobbyChimeRequest({this.LocationId});
    LobbyChimeRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        LocationId = json['LocationId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'LocationId': LocationId
    };

    getTypeName() => "LobbyChimeRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'LobbySettings': TypeInfo(TypeOf.Class, create:() => LobbySettings()),
    'LobbyChimeOption': TypeInfo(TypeOf.Class, create:() => LobbyChimeOption()),
    'LobbySettingsResponse': TypeInfo(TypeOf.Class, create:() => LobbySettingsResponse()),
    'List<LobbyChimeOption>': TypeInfo(TypeOf.Class, create:() => <LobbyChimeOption>[]),
    'LobbyChimeRequest': TypeInfo(TypeOf.Class, create:() => LobbyChimeRequest()),
});

Dart 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>