BokaMera.API.Host

<back to all web services

SettingsChangeLogQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/settings/changelogGet change log for settingsReturns a log of all changes made to company settings. Supports filtering and pagination via AutoQuery.
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Db;

namespace BokaMera.API.ServiceModel.Db
{
    public partial class BaseModel
    {
    }

    public partial class SettingsChangeLog
        : BaseModel, IBaseModelCreated
    {
        public virtual int Id { get; set; }
        [Required]
        public virtual Guid CompanyId { get; set; }

        [Required]
        [StringLength(128)]
        public virtual string SettingsType { get; set; }

        [Required]
        [StringLength(256)]
        public virtual string PropertyName { get; set; }

        [StringLength(int.MaxValue)]
        public virtual string? OldValue { get; set; }

        [StringLength(int.MaxValue)]
        public virtual string? NewValue { get; set; }

        [StringLength(256)]
        public virtual string? ModifiedBy { get; set; }

        [Required]
        public virtual DateTime CreatedDate { get; set; }

        public virtual DateTimeOffset? ModifiedDate { get; set; }
    }

}

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class AccessKeyTypeResponse
    {
        public virtual int Id { get; set; }
        public virtual string KeyType { get; set; }
        public virtual string Description { get; set; }
    }

    [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("IsAuthenticated")]
    public partial class SettingsChangeLogQuery
        : QueryDb<SettingsChangeLog, SettingsChangeLogQueryResponse>, 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 virtual Guid? CompanyId { 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")]
        public virtual string? SettingsType { get; set; }

        ///<summary>
        ///Filter by property name, e.g. SendEmailReminder
        ///</summary>
        [ApiMember(Description="Filter by property name, e.g. SendEmailReminder", ParameterType="query")]
        public virtual string? PropertyName { get; set; }

        ///<summary>
        ///Filter by who made the change
        ///</summary>
        [ApiMember(Description="Filter by who made the change", ParameterType="query")]
        public virtual string? ModifiedBy { get; set; }

        ///<summary>
        ///Filter changes created on or after this date
        ///</summary>
        [ApiMember(Description="Filter changes created on or after this date", ParameterType="query")]
        public virtual DateTime? CreatedDateGreaterThanOrEqualTo { get; set; }

        ///<summary>
        ///Filter changes created on or before this date
        ///</summary>
        [ApiMember(Description="Filter changes created on or before this date", ParameterType="query")]
        public virtual DateTime? CreatedDateLessThanOrEqualTo { get; set; }
    }

    public partial class SettingsChangeLogQueryResponse
    {
        ///<summary>
        ///The change log entry id
        ///</summary>
        [ApiMember(Description="The change log entry id")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The company id
        ///</summary>
        [ApiMember(Description="The company id")]
        public virtual Guid CompanyId { get; set; }

        ///<summary>
        ///The settings type that was changed, e.g. BookingSettings
        ///</summary>
        [ApiMember(Description="The settings type that was changed, e.g. BookingSettings")]
        public virtual string SettingsType { get; set; }

        ///<summary>
        ///The property name that was changed
        ///</summary>
        [ApiMember(Description="The property name that was changed")]
        public virtual string PropertyName { get; set; }

        ///<summary>
        ///The value before the change
        ///</summary>
        [ApiMember(Description="The value before the change")]
        public virtual string? OldValue { get; set; }

        ///<summary>
        ///The value after the change
        ///</summary>
        [ApiMember(Description="The value after the change")]
        public virtual string? NewValue { get; set; }

        ///<summary>
        ///The user who made the change
        ///</summary>
        [ApiMember(Description="The user who made the change")]
        public virtual string? ModifiedBy { get; set; }

        ///<summary>
        ///When the change was made
        ///</summary>
        [ApiMember(Description="When the change was made")]
        public virtual DateTime CreatedDate { get; set; }
    }

}

namespace ServiceStack
{
    [DataContract]
    public partial class QueryBase
    {
        [DataMember(Order=1)]
        public virtual int? Skip { get; set; }

        [DataMember(Order=2)]
        public virtual int? Take { get; set; }

        [DataMember(Order=3)]
        public virtual string? OrderBy { get; set; }

        [DataMember(Order=4)]
        public virtual string? OrderByDesc { get; set; }

        [DataMember(Order=5)]
        public virtual string? Include { get; set; }

        [DataMember(Order=6)]
        public virtual string? Fields { get; set; }

        [DataMember(Order=7)]
        public virtual Dictionary<string, string>? Meta { get; set; }
    }

    public partial class QueryDb<From, Into>
        : QueryBase
    {
    }

    [DataContract]
    public partial class QueryResponse<T>
    {
        [DataMember(Order=1)]
        public virtual int Offset { get; set; }

        [DataMember(Order=2)]
        public virtual int Total { get; set; }

        [DataMember(Order=3)]
        public virtual List<AccessKeyTypeResponse> Results { get; set; } = [];

        [DataMember(Order=4)]
        public virtual Dictionary<string, string>? Meta { get; set; }

        [DataMember(Order=5)]
        public virtual ResponseStatus? ResponseStatus { get; set; }
    }

}

C# SettingsChangeLogQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>