| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /settings/changelog | Get change log for settings | Returns a log of all changes made to company settings. Supports filtering and pagination via AutoQuery. |
|---|
import 'package:servicestack/servicestack.dart';
// @DataContract
abstract class QueryBase
{
// @DataMember(Order=1)
int? Skip;
// @DataMember(Order=2)
int? Take;
// @DataMember(Order=3)
String? OrderBy;
// @DataMember(Order=4)
String? OrderByDesc;
// @DataMember(Order=5)
String? Include;
// @DataMember(Order=6)
String? Fields;
// @DataMember(Order=7)
Map<String,String?>? Meta;
QueryBase({this.Skip,this.Take,this.OrderBy,this.OrderByDesc,this.Include,this.Fields,this.Meta});
QueryBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Skip = json['Skip'];
Take = json['Take'];
OrderBy = json['OrderBy'];
OrderByDesc = json['OrderByDesc'];
Include = json['Include'];
Fields = json['Fields'];
Meta = JsonConverters.toStringMap(json['Meta']);
return this;
}
Map<String, dynamic> toJson() => {
'Skip': Skip,
'Take': Take,
'OrderBy': OrderBy,
'OrderByDesc': OrderByDesc,
'Include': Include,
'Fields': Fields,
'Meta': Meta
};
getTypeName() => "QueryBase";
TypeContext? context = _ctx;
}
abstract class QueryDb2<From,Into> extends QueryBase
{
QueryDb2();
QueryDb2.fromJson(Map<String, dynamic> json) : super.fromJson(json);
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
return this;
}
Map<String, dynamic> toJson() => super.toJson();
getTypeName() => "QueryDb<$From,$Into>";
TypeContext? context = _ctx;
}
class SettingsChangeLogQueryResponse implements IConvertible
{
/**
* The change log entry id
*/
// @ApiMember(Description="The change log entry id")
int Id = 0;
/**
* The company id
*/
// @ApiMember(Description="The company id")
String CompanyId = "";
/**
* The settings type that was changed, e.g. BookingSettings
*/
// @ApiMember(Description="The settings type that was changed, e.g. BookingSettings")
String SettingsType = "";
/**
* The property name that was changed
*/
// @ApiMember(Description="The property name that was changed")
String PropertyName = "";
/**
* The value before the change
*/
// @ApiMember(Description="The value before the change")
String? OldValue;
/**
* The value after the change
*/
// @ApiMember(Description="The value after the change")
String? NewValue;
/**
* The user who made the change
*/
// @ApiMember(Description="The user who made the change")
String? ModifiedBy;
/**
* When the change was made
*/
// @ApiMember(Description="When the change was made")
DateTime CreatedDate = DateTime(0);
SettingsChangeLogQueryResponse({this.Id,this.CompanyId,this.SettingsType,this.PropertyName,this.OldValue,this.NewValue,this.ModifiedBy,this.CreatedDate});
SettingsChangeLogQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
CompanyId = json['CompanyId'];
SettingsType = json['SettingsType'];
PropertyName = json['PropertyName'];
OldValue = json['OldValue'];
NewValue = json['NewValue'];
ModifiedBy = json['ModifiedBy'];
CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'CompanyId': CompanyId,
'SettingsType': SettingsType,
'PropertyName': PropertyName,
'OldValue': OldValue,
'NewValue': NewValue,
'ModifiedBy': ModifiedBy,
'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!)
};
getTypeName() => "SettingsChangeLogQueryResponse";
TypeContext? context = _ctx;
}
class BaseModel implements IConvertible
{
BaseModel();
BaseModel.fromJson(Map<String, dynamic> json) : super();
fromMap(Map<String, dynamic> json) {
return this;
}
Map<String, dynamic> toJson() => {};
getTypeName() => "BaseModel";
TypeContext? context = _ctx;
}
class SettingsChangeLog extends BaseModel implements IBaseModelCreated, IConvertible
{
int Id = 0;
// @Required()
String CompanyId = "";
// @Required()
// @StringLength(128)
String SettingsType = "";
// @Required()
// @StringLength(256)
String PropertyName = "";
// @StringLength(2147483647)
String? OldValue;
// @StringLength(2147483647)
String? NewValue;
// @StringLength(256)
String? ModifiedBy;
// @Required()
DateTime CreatedDate = DateTime(0);
DateTime? ModifiedDate;
SettingsChangeLog({this.Id,this.CompanyId,this.SettingsType,this.PropertyName,this.OldValue,this.NewValue,this.ModifiedBy,this.CreatedDate,this.ModifiedDate});
SettingsChangeLog.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Id = json['Id'];
CompanyId = json['CompanyId'];
SettingsType = json['SettingsType'];
PropertyName = json['PropertyName'];
OldValue = json['OldValue'];
NewValue = json['NewValue'];
ModifiedBy = json['ModifiedBy'];
CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Id': Id,
'CompanyId': CompanyId,
'SettingsType': SettingsType,
'PropertyName': PropertyName,
'OldValue': OldValue,
'NewValue': NewValue,
'ModifiedBy': ModifiedBy,
'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!)
});
getTypeName() => "SettingsChangeLog";
TypeContext? context = _ctx;
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privileges to call this service", StatusCode=403)
// @ValidateRequest(Validator="IsAuthenticated")
class SettingsChangeLogQuery extends QueryDb2<SettingsChangeLog,SettingsChangeLogQueryResponse> implements ICompany, IConvertible
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
// @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.", ParameterType="query")
String? CompanyId;
/**
* Filter by settings type, e.g. BookingSettings, PaymentSettings, CompanySetting, EAccountingSettings
*/
// @ApiMember(Description="Filter by settings type, e.g. BookingSettings, PaymentSettings, CompanySetting, EAccountingSettings", ParameterType="query")
String? SettingsType;
/**
* Filter by property name, e.g. SendEmailReminder
*/
// @ApiMember(Description="Filter by property name, e.g. SendEmailReminder", ParameterType="query")
String? PropertyName;
/**
* Filter by who made the change
*/
// @ApiMember(Description="Filter by who made the change", ParameterType="query")
String? ModifiedBy;
/**
* Filter changes created on or after this date
*/
// @ApiMember(Description="Filter changes created on or after this date", ParameterType="query")
DateTime? CreatedDateGreaterThanOrEqualTo;
/**
* Filter changes created on or before this date
*/
// @ApiMember(Description="Filter changes created on or before this date", ParameterType="query")
DateTime? CreatedDateLessThanOrEqualTo;
SettingsChangeLogQuery({this.CompanyId,this.SettingsType,this.PropertyName,this.ModifiedBy,this.CreatedDateGreaterThanOrEqualTo,this.CreatedDateLessThanOrEqualTo});
SettingsChangeLogQuery.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
CompanyId = json['CompanyId'];
SettingsType = json['SettingsType'];
PropertyName = json['PropertyName'];
ModifiedBy = json['ModifiedBy'];
CreatedDateGreaterThanOrEqualTo = JsonConverters.fromJson(json['CreatedDateGreaterThanOrEqualTo'],'DateTime',context!);
CreatedDateLessThanOrEqualTo = JsonConverters.fromJson(json['CreatedDateLessThanOrEqualTo'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'CompanyId': CompanyId,
'SettingsType': SettingsType,
'PropertyName': PropertyName,
'ModifiedBy': ModifiedBy,
'CreatedDateGreaterThanOrEqualTo': JsonConverters.toJson(CreatedDateGreaterThanOrEqualTo,'DateTime',context!),
'CreatedDateLessThanOrEqualTo': JsonConverters.toJson(CreatedDateLessThanOrEqualTo,'DateTime',context!)
});
getTypeName() => "SettingsChangeLogQuery";
TypeContext? context = _ctx;
}
class AccessKeyTypeResponse implements IConvertible
{
int Id = 0;
String KeyType = "";
String Description = "";
AccessKeyTypeResponse({this.Id,this.KeyType,this.Description});
AccessKeyTypeResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
KeyType = json['KeyType'];
Description = json['Description'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'KeyType': KeyType,
'Description': Description
};
getTypeName() => "AccessKeyTypeResponse";
TypeContext? context = _ctx;
}
// @DataContract
class QueryResponse<T> implements IConvertible
{
// @DataMember(Order=1)
int Offset = 0;
// @DataMember(Order=2)
int Total = 0;
// @DataMember(Order=3)
List<AccessKeyTypeResponse> Results = [];
// @DataMember(Order=4)
Map<String,String?>? Meta;
// @DataMember(Order=5)
ResponseStatus? ResponseStatus;
QueryResponse({this.Offset,this.Total,this.Results,this.Meta,this.ResponseStatus});
QueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Offset = json['Offset'];
Total = json['Total'];
Results = JsonConverters.fromJson(json['Results'],'List<AccessKeyTypeResponse>',context!);
Meta = JsonConverters.toStringMap(json['Meta']);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Offset': Offset,
'Total': Total,
'Results': JsonConverters.toJson(Results,'List<AccessKeyTypeResponse>',context!),
'Meta': Meta,
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "QueryResponse<$T>";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
'SettingsChangeLogQueryResponse': TypeInfo(TypeOf.Class, create:() => SettingsChangeLogQueryResponse()),
'BaseModel': TypeInfo(TypeOf.Class, create:() => BaseModel()),
'SettingsChangeLog': TypeInfo(TypeOf.Class, create:() => SettingsChangeLog()),
'SettingsChangeLogQuery': TypeInfo(TypeOf.Class, create:() => SettingsChangeLogQuery()),
'List<SettingsChangeLogQueryResponse>': TypeInfo(TypeOf.Class, create:() => <SettingsChangeLogQueryResponse>[]),
'AccessKeyTypeResponse': TypeInfo(TypeOf.Class, create:() => AccessKeyTypeResponse()),
'List<AccessKeyTypeResponse>': TypeInfo(TypeOf.Class, create:() => <AccessKeyTypeResponse>[]),
});
Dart SettingsChangeLogQuery 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /settings/changelog HTTP/1.1 Host: testapi.bokamera.se Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Id":0,"SettingsType":"String","PropertyName":"String","OldValue":"String","NewValue":"String","ModifiedBy":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}