| 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.*;
public class dtos
{
@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 static class SettingsChangeLogQuery extends QueryDb<SettingsChangeLog, SettingsChangeLogQueryResponse> implements 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 UUID CompanyId = 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")
public String SettingsType = null;
/**
* Filter by property name, e.g. SendEmailReminder
*/
@ApiMember(Description="Filter by property name, e.g. SendEmailReminder", ParameterType="query")
public String PropertyName = null;
/**
* Filter by who made the change
*/
@ApiMember(Description="Filter by who made the change", ParameterType="query")
public String ModifiedBy = null;
/**
* Filter changes created on or after this date
*/
@ApiMember(Description="Filter changes created on or after this date", ParameterType="query")
public Date CreatedDateGreaterThanOrEqualTo = null;
/**
* Filter changes created on or before this date
*/
@ApiMember(Description="Filter changes created on or before this date", ParameterType="query")
public Date CreatedDateLessThanOrEqualTo = null;
public UUID getCompanyId() { return CompanyId; }
public SettingsChangeLogQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
public String getSettingsType() { return SettingsType; }
public SettingsChangeLogQuery setSettingsType(String value) { this.SettingsType = value; return this; }
public String getPropertyName() { return PropertyName; }
public SettingsChangeLogQuery setPropertyName(String value) { this.PropertyName = value; return this; }
public String getModifiedBy() { return ModifiedBy; }
public SettingsChangeLogQuery setModifiedBy(String value) { this.ModifiedBy = value; return this; }
public Date getCreatedDateGreaterThanOrEqualTo() { return CreatedDateGreaterThanOrEqualTo; }
public SettingsChangeLogQuery setCreatedDateGreaterThanOrEqualTo(Date value) { this.CreatedDateGreaterThanOrEqualTo = value; return this; }
public Date getCreatedDateLessThanOrEqualTo() { return CreatedDateLessThanOrEqualTo; }
public SettingsChangeLogQuery setCreatedDateLessThanOrEqualTo(Date value) { this.CreatedDateLessThanOrEqualTo = value; return this; }
}
public static class QueryDb<From, Into> extends QueryBase
{
}
@DataContract
public static class QueryBase
{
@DataMember(Order=1)
public Integer Skip = null;
@DataMember(Order=2)
public Integer Take = null;
@DataMember(Order=3)
public String OrderBy = null;
@DataMember(Order=4)
public String OrderByDesc = null;
@DataMember(Order=5)
public String Include = null;
@DataMember(Order=6)
public String Fields = null;
@DataMember(Order=7)
public HashMap<String,String> Meta = null;
public Integer getSkip() { return Skip; }
public QueryBase setSkip(Integer value) { this.Skip = value; return this; }
public Integer getTake() { return Take; }
public QueryBase setTake(Integer value) { this.Take = value; return this; }
public String getOrderBy() { return OrderBy; }
public QueryBase setOrderBy(String value) { this.OrderBy = value; return this; }
public String getOrderByDesc() { return OrderByDesc; }
public QueryBase setOrderByDesc(String value) { this.OrderByDesc = value; return this; }
public String getInclude() { return Include; }
public QueryBase setInclude(String value) { this.Include = value; return this; }
public String getFields() { return Fields; }
public QueryBase setFields(String value) { this.Fields = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryBase setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
}
public static class SettingsChangeLog extends BaseModel implements IBaseModelCreated
{
public Integer Id = null;
@Required()
public UUID CompanyId = null;
@Required()
@StringLength(MaximumLength=128)
public String SettingsType = null;
@Required()
@StringLength(MaximumLength=256)
public String PropertyName = null;
@StringLength(MaximumLength=2147483647)
public String OldValue = null;
@StringLength(MaximumLength=2147483647)
public String NewValue = null;
@StringLength(MaximumLength=256)
public String ModifiedBy = null;
@Required()
public Date CreatedDate = null;
public Date ModifiedDate = null;
public Integer getId() { return Id; }
public SettingsChangeLog setId(Integer value) { this.Id = value; return this; }
public UUID getCompanyId() { return CompanyId; }
public SettingsChangeLog setCompanyId(UUID value) { this.CompanyId = value; return this; }
public String getSettingsType() { return SettingsType; }
public SettingsChangeLog setSettingsType(String value) { this.SettingsType = value; return this; }
public String getPropertyName() { return PropertyName; }
public SettingsChangeLog setPropertyName(String value) { this.PropertyName = value; return this; }
public String getOldValue() { return OldValue; }
public SettingsChangeLog setOldValue(String value) { this.OldValue = value; return this; }
public String getNewValue() { return NewValue; }
public SettingsChangeLog setNewValue(String value) { this.NewValue = value; return this; }
public String getModifiedBy() { return ModifiedBy; }
public SettingsChangeLog setModifiedBy(String value) { this.ModifiedBy = value; return this; }
public Date getCreatedDate() { return CreatedDate; }
public SettingsChangeLog setCreatedDate(Date value) { this.CreatedDate = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public SettingsChangeLog setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
}
public static class BaseModel
{
}
public static class SettingsChangeLogQueryResponse
{
/**
* The change log entry id
*/
@ApiMember(Description="The change log entry id")
public Integer Id = null;
/**
* The company id
*/
@ApiMember(Description="The company id")
public UUID CompanyId = null;
/**
* The settings type that was changed, e.g. BookingSettings
*/
@ApiMember(Description="The settings type that was changed, e.g. BookingSettings")
public String SettingsType = null;
/**
* The property name that was changed
*/
@ApiMember(Description="The property name that was changed")
public String PropertyName = null;
/**
* The value before the change
*/
@ApiMember(Description="The value before the change")
public String OldValue = null;
/**
* The value after the change
*/
@ApiMember(Description="The value after the change")
public String NewValue = null;
/**
* The user who made the change
*/
@ApiMember(Description="The user who made the change")
public String ModifiedBy = null;
/**
* When the change was made
*/
@ApiMember(Description="When the change was made")
public Date CreatedDate = null;
public Integer getId() { return Id; }
public SettingsChangeLogQueryResponse setId(Integer value) { this.Id = value; return this; }
public UUID getCompanyId() { return CompanyId; }
public SettingsChangeLogQueryResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
public String getSettingsType() { return SettingsType; }
public SettingsChangeLogQueryResponse setSettingsType(String value) { this.SettingsType = value; return this; }
public String getPropertyName() { return PropertyName; }
public SettingsChangeLogQueryResponse setPropertyName(String value) { this.PropertyName = value; return this; }
public String getOldValue() { return OldValue; }
public SettingsChangeLogQueryResponse setOldValue(String value) { this.OldValue = value; return this; }
public String getNewValue() { return NewValue; }
public SettingsChangeLogQueryResponse setNewValue(String value) { this.NewValue = value; return this; }
public String getModifiedBy() { return ModifiedBy; }
public SettingsChangeLogQueryResponse setModifiedBy(String value) { this.ModifiedBy = value; return this; }
public Date getCreatedDate() { return CreatedDate; }
public SettingsChangeLogQueryResponse setCreatedDate(Date value) { this.CreatedDate = value; return this; }
}
@DataContract
public static class QueryResponse<T>
{
@DataMember(Order=1)
public Integer Offset = null;
@DataMember(Order=2)
public Integer Total = null;
@DataMember(Order=3)
public ArrayList<AccessKeyTypeResponse> Results = new ArrayList<AccessKeyTypeResponse>();
@DataMember(Order=4)
public HashMap<String,String> Meta = null;
@DataMember(Order=5)
public ResponseStatus ResponseStatus = null;
public Integer getOffset() { return Offset; }
public QueryResponse<T> setOffset(Integer value) { this.Offset = value; return this; }
public Integer getTotal() { return Total; }
public QueryResponse<T> setTotal(Integer value) { this.Total = value; return this; }
public ArrayList<AccessKeyTypeResponse> getResults() { return Results; }
public QueryResponse<T> setResults(ArrayList<AccessKeyTypeResponse> value) { this.Results = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryResponse<T> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public QueryResponse<T> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class AccessKeyTypeResponse
{
public Integer Id = null;
public String KeyType = null;
public String Description = null;
public Integer getId() { return Id; }
public AccessKeyTypeResponse setId(Integer value) { this.Id = value; return this; }
public String getKeyType() { return KeyType; }
public AccessKeyTypeResponse setKeyType(String value) { this.KeyType = value; return this; }
public String getDescription() { return Description; }
public AccessKeyTypeResponse setDescription(String value) { this.Description = value; return this; }
}
}
Java 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
}
}
}