| 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. |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports BokaMera.API.ServiceModel.Db
Namespace Global
Namespace BokaMera.API.ServiceModel.Db
Public Partial Class BaseModel
End Class
Public Partial Class SettingsChangeLog
Inherits BaseModel
Implements IBaseModelCreated
Public Overridable Property Id As Integer
<Required>
Public Overridable Property CompanyId As Guid
<Required>
<StringLength(128)>
Public Overridable Property SettingsType As String
<Required>
<StringLength(256)>
Public Overridable Property PropertyName As String
<StringLength(Integer.MaxValue)>
Public Overridable Property OldValue As String
<StringLength(Integer.MaxValue)>
Public Overridable Property NewValue As String
<StringLength(256)>
Public Overridable Property ModifiedBy As String
<Required>
Public Overridable Property CreatedDate As Date Implements IBaseModelCreated.CreatedDate
Public Overridable Property ModifiedDate As DateTimeOffset?
End Class
End Namespace
Namespace BokaMera.API.ServiceModel.Dtos
Public Partial Class AccessKeyTypeResponse
Public Overridable Property Id As Integer
Public Overridable Property KeyType As String
Public Overridable Property Description As String
End Class
<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 Partial Class SettingsChangeLogQuery
Inherits QueryDb(Of SettingsChangeLog, SettingsChangeLogQueryResponse)
Implements ICompany
'''<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")>
Public Overridable Property CompanyId As Guid? Implements ICompany.CompanyId
'''<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")>
Public Overridable Property SettingsType As String
'''<Summary>
'''Filter by property name, e.g. SendEmailReminder
'''</Summary>
<ApiMember(Description:="Filter by property name, e.g. SendEmailReminder", ParameterType:="query")>
Public Overridable Property PropertyName As String
'''<Summary>
'''Filter by who made the change
'''</Summary>
<ApiMember(Description:="Filter by who made the change", ParameterType:="query")>
Public Overridable Property ModifiedBy As String
'''<Summary>
'''Filter changes created on or after this date
'''</Summary>
<ApiMember(Description:="Filter changes created on or after this date", ParameterType:="query")>
Public Overridable Property CreatedDateGreaterThanOrEqualTo As Date?
'''<Summary>
'''Filter changes created on or before this date
'''</Summary>
<ApiMember(Description:="Filter changes created on or before this date", ParameterType:="query")>
Public Overridable Property CreatedDateLessThanOrEqualTo As Date?
End Class
Public Partial Class SettingsChangeLogQueryResponse
'''<Summary>
'''The change log entry id
'''</Summary>
<ApiMember(Description:="The change log entry id")>
Public Overridable Property Id As Integer
'''<Summary>
'''The company id
'''</Summary>
<ApiMember(Description:="The company id")>
Public Overridable Property CompanyId As Guid
'''<Summary>
'''The settings type that was changed, e.g. BookingSettings
'''</Summary>
<ApiMember(Description:="The settings type that was changed, e.g. BookingSettings")>
Public Overridable Property SettingsType As String
'''<Summary>
'''The property name that was changed
'''</Summary>
<ApiMember(Description:="The property name that was changed")>
Public Overridable Property PropertyName As String
'''<Summary>
'''The value before the change
'''</Summary>
<ApiMember(Description:="The value before the change")>
Public Overridable Property OldValue As String
'''<Summary>
'''The value after the change
'''</Summary>
<ApiMember(Description:="The value after the change")>
Public Overridable Property NewValue As String
'''<Summary>
'''The user who made the change
'''</Summary>
<ApiMember(Description:="The user who made the change")>
Public Overridable Property ModifiedBy As String
'''<Summary>
'''When the change was made
'''</Summary>
<ApiMember(Description:="When the change was made")>
Public Overridable Property CreatedDate As Date
End Class
End Namespace
Namespace ServiceStack
<DataContract>
Public Partial Class QueryBase
<DataMember(Order:=1)>
Public Overridable Property Skip As Integer?
<DataMember(Order:=2)>
Public Overridable Property Take As Integer?
<DataMember(Order:=3)>
Public Overridable Property OrderBy As String
<DataMember(Order:=4)>
Public Overridable Property OrderByDesc As String
<DataMember(Order:=5)>
Public Overridable Property Include As String
<DataMember(Order:=6)>
Public Overridable Property Fields As String
<DataMember(Order:=7)>
Public Overridable Property Meta As Dictionary(Of String, String)
End Class
Public Partial Class QueryDb(Of From, Into)
Inherits QueryBase
End Class
<DataContract>
Public Partial Class QueryResponse(Of T)
<DataMember(Order:=1)>
Public Overridable Property Offset As Integer
<DataMember(Order:=2)>
Public Overridable Property Total As Integer
<DataMember(Order:=3)>
Public Overridable Property Results As List(Of AccessKeyTypeResponse) = New List(Of AccessKeyTypeResponse)
<DataMember(Order:=4)>
Public Overridable Property Meta As Dictionary(Of String, String)
<DataMember(Order:=5)>
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
VB.NET 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"}}}