| 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. |
|---|
namespace BokaMera.API.ServiceModel.Db
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type SettingsChangeLogQueryResponse() =
///<summary>
///The change log entry id
///</summary>
[<ApiMember(Description="The change log entry id")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The company id
///</summary>
[<ApiMember(Description="The company id")>]
member val CompanyId:Guid = new Guid() with get,set
///<summary>
///The settings type that was changed, e.g. BookingSettings
///</summary>
[<ApiMember(Description="The settings type that was changed, e.g. BookingSettings")>]
member val SettingsType:String = null with get,set
///<summary>
///The property name that was changed
///</summary>
[<ApiMember(Description="The property name that was changed")>]
member val PropertyName:String = null with get,set
///<summary>
///The value before the change
///</summary>
[<ApiMember(Description="The value before the change")>]
member val OldValue:String = null with get,set
///<summary>
///The value after the change
///</summary>
[<ApiMember(Description="The value after the change")>]
member val NewValue:String = null with get,set
///<summary>
///The user who made the change
///</summary>
[<ApiMember(Description="The user who made the change")>]
member val ModifiedBy:String = null with get,set
///<summary>
///When the change was made
///</summary>
[<ApiMember(Description="When the change was made")>]
member val CreatedDate:DateTime = new DateTime() with get,set
[<AllowNullLiteral>]
type BaseModel() =
class end
[<AllowNullLiteral>]
type SettingsChangeLog() =
inherit BaseModel()
member val Id:Int32 = new Int32() with get,set
[<Required>]
member val CompanyId:Guid = new Guid() with get,set
[<Required>]
[<StringLength(128)>]
member val SettingsType:String = null with get,set
[<Required>]
[<StringLength(256)>]
member val PropertyName:String = null with get,set
[<StringLength(Int32.MaxValue)>]
member val OldValue:String = null with get,set
[<StringLength(Int32.MaxValue)>]
member val NewValue:String = null with get,set
[<StringLength(256)>]
member val ModifiedBy:String = null with get,set
[<Required>]
member val CreatedDate:DateTime = new DateTime() with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryBase() =
[<DataMember(Order=1)>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=2)>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=3)>]
member val OrderBy:String = null with get,set
[<DataMember(Order=4)>]
member val OrderByDesc:String = null with get,set
[<DataMember(Order=5)>]
member val Include:String = null with get,set
[<DataMember(Order=6)>]
member val Fields:String = null with get,set
[<DataMember(Order=7)>]
member val Meta:Dictionary<String, String> = null with get,set
[<AllowNullLiteral>]
type QueryDb<From, Into>() =
inherit QueryBase()
[<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")>]
[<AllowNullLiteral>]
type SettingsChangeLogQuery() =
inherit QueryDb<SettingsChangeLog, SettingsChangeLogQueryResponse>()
///<summary>
///The company id, if empty will use the company id for the user you are logged in with.
///</summary>
[<ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.", ParameterType="query")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///Filter by settings type, e.g. BookingSettings, PaymentSettings, CompanySetting, EAccountingSettings
///</summary>
[<ApiMember(Description="Filter by settings type, e.g. BookingSettings, PaymentSettings, CompanySetting, EAccountingSettings", ParameterType="query")>]
member val SettingsType:String = null with get,set
///<summary>
///Filter by property name, e.g. SendEmailReminder
///</summary>
[<ApiMember(Description="Filter by property name, e.g. SendEmailReminder", ParameterType="query")>]
member val PropertyName:String = null with get,set
///<summary>
///Filter by who made the change
///</summary>
[<ApiMember(Description="Filter by who made the change", ParameterType="query")>]
member val ModifiedBy:String = null with get,set
///<summary>
///Filter changes created on or after this date
///</summary>
[<ApiMember(Description="Filter changes created on or after this date", ParameterType="query")>]
member val CreatedDateGreaterThanOrEqualTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///Filter changes created on or before this date
///</summary>
[<ApiMember(Description="Filter changes created on or before this date", ParameterType="query")>]
member val CreatedDateLessThanOrEqualTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<AllowNullLiteral>]
type AccessKeyTypeResponse() =
member val Id:Int32 = new Int32() with get,set
member val KeyType:String = null with get,set
member val Description:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<T>() =
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<AccessKeyTypeResponse> = null with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = null with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
F# SettingsChangeLogQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfSettingsChangeLogQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Offset>0</Offset>
<Total>0</Total>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<d2p1:SettingsChangeLogQueryResponse>
<d2p1:CompanyId>00000000-0000-0000-0000-000000000000</d2p1:CompanyId>
<d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
<d2p1:Id>0</d2p1:Id>
<d2p1:ModifiedBy>String</d2p1:ModifiedBy>
<d2p1:NewValue>String</d2p1:NewValue>
<d2p1:OldValue>String</d2p1:OldValue>
<d2p1:PropertyName>String</d2p1:PropertyName>
<d2p1:SettingsType>String</d2p1:SettingsType>
</d2p1:SettingsChangeLogQueryResponse>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
</QueryResponseOfSettingsChangeLogQueryResponseWg5EthtI>