| 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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
@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")
open class SettingsChangeLogQuery : QueryDb<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")
override var CompanyId:UUID? = null
/**
* Filter by settings type, e.g. BookingSettings, PaymentSettings, CompanySetting, EAccountingSettings
*/
@ApiMember(Description="Filter by settings type, e.g. BookingSettings, PaymentSettings, CompanySetting, EAccountingSettings", ParameterType="query")
open var SettingsType:String? = null
/**
* Filter by property name, e.g. SendEmailReminder
*/
@ApiMember(Description="Filter by property name, e.g. SendEmailReminder", ParameterType="query")
open var PropertyName:String? = null
/**
* Filter by who made the change
*/
@ApiMember(Description="Filter by who made the change", ParameterType="query")
open var ModifiedBy:String? = null
/**
* Filter changes created on or after this date
*/
@ApiMember(Description="Filter changes created on or after this date", ParameterType="query")
open var CreatedDateGreaterThanOrEqualTo:Date? = null
/**
* Filter changes created on or before this date
*/
@ApiMember(Description="Filter changes created on or before this date", ParameterType="query")
open var CreatedDateLessThanOrEqualTo:Date? = null
}
open class QueryDb<From, Into> : QueryBase()
{
}
@DataContract
open class QueryBase
{
@DataMember(Order=1)
open var Skip:Int? = null
@DataMember(Order=2)
open var Take:Int? = null
@DataMember(Order=3)
open var OrderBy:String? = null
@DataMember(Order=4)
open var OrderByDesc:String? = null
@DataMember(Order=5)
open var Include:String? = null
@DataMember(Order=6)
open var Fields:String? = null
@DataMember(Order=7)
open var Meta:HashMap<String,String>? = null
}
open class SettingsChangeLog : BaseModel(), IBaseModelCreated
{
open var Id:Int? = null
@Required()
open var CompanyId:UUID? = null
@Required()
@StringLength(MaximumLength=128)
open var SettingsType:String? = null
@Required()
@StringLength(MaximumLength=256)
open var PropertyName:String? = null
@StringLength(MaximumLength=2147483647)
open var OldValue:String? = null
@StringLength(MaximumLength=2147483647)
open var NewValue:String? = null
@StringLength(MaximumLength=256)
open var ModifiedBy:String? = null
@Required()
override var CreatedDate:Date? = null
open var ModifiedDate:Date? = null
}
open class BaseModel
{
}
open class SettingsChangeLogQueryResponse
{
/**
* The change log entry id
*/
@ApiMember(Description="The change log entry id")
open var Id:Int? = null
/**
* The company id
*/
@ApiMember(Description="The company id")
open var CompanyId:UUID? = null
/**
* The settings type that was changed, e.g. BookingSettings
*/
@ApiMember(Description="The settings type that was changed, e.g. BookingSettings")
open var SettingsType:String? = null
/**
* The property name that was changed
*/
@ApiMember(Description="The property name that was changed")
open var PropertyName:String? = null
/**
* The value before the change
*/
@ApiMember(Description="The value before the change")
open var OldValue:String? = null
/**
* The value after the change
*/
@ApiMember(Description="The value after the change")
open var NewValue:String? = null
/**
* The user who made the change
*/
@ApiMember(Description="The user who made the change")
open var ModifiedBy:String? = null
/**
* When the change was made
*/
@ApiMember(Description="When the change was made")
open var CreatedDate:Date? = null
}
@DataContract
open class QueryResponse<T>
{
@DataMember(Order=1)
open var Offset:Int? = null
@DataMember(Order=2)
open var Total:Int? = null
@DataMember(Order=3)
open var Results:ArrayList<AccessKeyTypeResponse> = ArrayList<AccessKeyTypeResponse>()
@DataMember(Order=4)
open var Meta:HashMap<String,String>? = null
@DataMember(Order=5)
open var ResponseStatus:ResponseStatus? = null
}
open class AccessKeyTypeResponse
{
open var Id:Int? = null
open var KeyType:String? = null
open var Description:String? = null
}
Kotlin 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
}
}
}