| Requires any of the roles: | Agent, Administrator |
| GET,PUT,OPTIONS | /v1/queue/lobby-settings/{LocationId} |
|---|
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 LobbySettingsRequest implements IConvertible
{
String? LocationId;
String? WaitSource;
String? MonitorChime;
int? MonitorVolume;
bool? MonitorAnnounce;
String? MonitorAnnounceTemplate;
String? MonitorVoice;
double? MonitorVoiceRate;
int? MonitorRepeatAfterSec;
bool? MonitorTicketOnly;
String? LobbyZoneMode;
int? LobbyTakeoverEveryMin;
int? LobbyTakeoverSec;
bool? LobbyIdleScreen;
LobbySettingsRequest({this.LocationId,this.WaitSource,this.MonitorChime,this.MonitorVolume,this.MonitorAnnounce,this.MonitorAnnounceTemplate,this.MonitorVoice,this.MonitorVoiceRate,this.MonitorRepeatAfterSec,this.MonitorTicketOnly,this.LobbyZoneMode,this.LobbyTakeoverEveryMin,this.LobbyTakeoverSec,this.LobbyIdleScreen});
LobbySettingsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
LocationId = json['LocationId'];
WaitSource = json['WaitSource'];
MonitorChime = json['MonitorChime'];
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'];
return this;
}
Map<String, dynamic> toJson() => {
'LocationId': LocationId,
'WaitSource': WaitSource,
'MonitorChime': MonitorChime,
'MonitorVolume': MonitorVolume,
'MonitorAnnounce': MonitorAnnounce,
'MonitorAnnounceTemplate': MonitorAnnounceTemplate,
'MonitorVoice': MonitorVoice,
'MonitorVoiceRate': MonitorVoiceRate,
'MonitorRepeatAfterSec': MonitorRepeatAfterSec,
'MonitorTicketOnly': MonitorTicketOnly,
'LobbyZoneMode': LobbyZoneMode,
'LobbyTakeoverEveryMin': LobbyTakeoverEveryMin,
'LobbyTakeoverSec': LobbyTakeoverSec,
'LobbyIdleScreen': LobbyIdleScreen
};
getTypeName() => "LobbySettingsRequest";
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>[]),
'LobbySettingsRequest': TypeInfo(TypeOf.Class, create:() => LobbySettingsRequest()),
});
Dart LobbySettingsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
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: text/jsv
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
}
]
}