| 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 Foundation
import ServiceStack
// @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")
public class SettingsChangeLogQuery : QueryDb2<SettingsChangeLog, SettingsChangeLogQueryResponse>, ICompany
{
/**
* 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")
public var companyId:String?
/**
* Filter by settings type, e.g. BookingSettings, PaymentSettings, CompanySetting, EAccountingSettings
*/
// @ApiMember(Description="Filter by settings type, e.g. BookingSettings, PaymentSettings, CompanySetting, EAccountingSettings", ParameterType="query")
public var settingsType:String
/**
* Filter by property name, e.g. SendEmailReminder
*/
// @ApiMember(Description="Filter by property name, e.g. SendEmailReminder", ParameterType="query")
public var propertyName:String
/**
* Filter by who made the change
*/
// @ApiMember(Description="Filter by who made the change", ParameterType="query")
public var modifiedBy:String
/**
* Filter changes created on or after this date
*/
// @ApiMember(Description="Filter changes created on or after this date", ParameterType="query")
public var createdDateGreaterThanOrEqualTo:Date?
/**
* Filter changes created on or before this date
*/
// @ApiMember(Description="Filter changes created on or before this date", ParameterType="query")
public var createdDateLessThanOrEqualTo:Date?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case companyId
case settingsType
case propertyName
case modifiedBy
case createdDateGreaterThanOrEqualTo
case createdDateLessThanOrEqualTo
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
settingsType = try container.decodeIfPresent(String.self, forKey: .settingsType)
propertyName = try container.decodeIfPresent(String.self, forKey: .propertyName)
modifiedBy = try container.decodeIfPresent(String.self, forKey: .modifiedBy)
createdDateGreaterThanOrEqualTo = try container.decodeIfPresent(Date.self, forKey: .createdDateGreaterThanOrEqualTo)
createdDateLessThanOrEqualTo = try container.decodeIfPresent(Date.self, forKey: .createdDateLessThanOrEqualTo)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if companyId != nil { try container.encode(companyId, forKey: .companyId) }
if settingsType != nil { try container.encode(settingsType, forKey: .settingsType) }
if propertyName != nil { try container.encode(propertyName, forKey: .propertyName) }
if modifiedBy != nil { try container.encode(modifiedBy, forKey: .modifiedBy) }
if createdDateGreaterThanOrEqualTo != nil { try container.encode(createdDateGreaterThanOrEqualTo, forKey: .createdDateGreaterThanOrEqualTo) }
if createdDateLessThanOrEqualTo != nil { try container.encode(createdDateLessThanOrEqualTo, forKey: .createdDateLessThanOrEqualTo) }
}
}
public class SettingsChangeLog : BaseModel, IBaseModelCreated
{
public var id:Int
// @Required()
public var companyId:String?
// @Required()
// @StringLength(128)
public var settingsType:String?
// @Required()
// @StringLength(256)
public var propertyName:String?
// @StringLength(Int32.max)
public var oldValue:String
// @StringLength(Int32.max)
public var newValue:String
// @StringLength(256)
public var modifiedBy:String
// @Required()
public var createdDate:Date?
public var modifiedDate:Date?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case id
case companyId
case settingsType
case propertyName
case oldValue
case newValue
case modifiedBy
case createdDate
case modifiedDate
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
id = try container.decodeIfPresent(Int.self, forKey: .id)
companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
settingsType = try container.decodeIfPresent(String.self, forKey: .settingsType)
propertyName = try container.decodeIfPresent(String.self, forKey: .propertyName)
oldValue = try container.decodeIfPresent(String.self, forKey: .oldValue)
newValue = try container.decodeIfPresent(String.self, forKey: .newValue)
modifiedBy = try container.decodeIfPresent(String.self, forKey: .modifiedBy)
createdDate = try container.decodeIfPresent(Date.self, forKey: .createdDate)
modifiedDate = try container.decodeIfPresent(Date.self, forKey: .modifiedDate)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if id != nil { try container.encode(id, forKey: .id) }
if companyId != nil { try container.encode(companyId, forKey: .companyId) }
if settingsType != nil { try container.encode(settingsType, forKey: .settingsType) }
if propertyName != nil { try container.encode(propertyName, forKey: .propertyName) }
if oldValue != nil { try container.encode(oldValue, forKey: .oldValue) }
if newValue != nil { try container.encode(newValue, forKey: .newValue) }
if modifiedBy != nil { try container.encode(modifiedBy, forKey: .modifiedBy) }
if createdDate != nil { try container.encode(createdDate, forKey: .createdDate) }
if modifiedDate != nil { try container.encode(modifiedDate, forKey: .modifiedDate) }
}
}
public class BaseModel : Codable
{
required public init(){}
}
public class SettingsChangeLogQueryResponse : Codable
{
/**
* The change log entry id
*/
// @ApiMember(Description="The change log entry id")
public var id:Int
/**
* The company id
*/
// @ApiMember(Description="The company id")
public var companyId:String
/**
* The settings type that was changed, e.g. BookingSettings
*/
// @ApiMember(Description="The settings type that was changed, e.g. BookingSettings")
public var settingsType:String
/**
* The property name that was changed
*/
// @ApiMember(Description="The property name that was changed")
public var propertyName:String
/**
* The value before the change
*/
// @ApiMember(Description="The value before the change")
public var oldValue:String
/**
* The value after the change
*/
// @ApiMember(Description="The value after the change")
public var newValue:String
/**
* The user who made the change
*/
// @ApiMember(Description="The user who made the change")
public var modifiedBy:String
/**
* When the change was made
*/
// @ApiMember(Description="When the change was made")
public var createdDate:Date
required public init(){}
}
public class AccessKeyTypeResponse : Codable
{
public var id:Int
public var keyType:String
public var Description:String
required public init(){}
}
Swift SettingsChangeLogQuery 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.
GET /settings/changelog HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}