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.
// @ts-nocheck

// @DataContract
export class QueryBase
{
    // @DataMember(Order=1)
    public Skip?: number;

    // @DataMember(Order=2)
    public Take?: number;

    // @DataMember(Order=3)
    public OrderBy?: string;

    // @DataMember(Order=4)
    public OrderByDesc?: string;

    // @DataMember(Order=5)
    public Include?: string;

    // @DataMember(Order=6)
    public Fields?: string;

    // @DataMember(Order=7)
    public Meta?: { [index:string]: string; };

    public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}

export class QueryDb<From, Into> extends QueryBase
{

    public constructor(init?: Partial<QueryDb<From, Into>>) { super(init); (Object as any).assign(this, init); }
}

export class SettingsChangeLogQueryResponse
{
    /** @description The change log entry id */
    // @ApiMember(Description="The change log entry id")
    public Id: number;

    /** @description The company id */
    // @ApiMember(Description="The company id")
    public CompanyId: string;

    /** @description The settings type that was changed, e.g. BookingSettings */
    // @ApiMember(Description="The settings type that was changed, e.g. BookingSettings")
    public SettingsType: string;

    /** @description The property name that was changed */
    // @ApiMember(Description="The property name that was changed")
    public PropertyName: string;

    /** @description The value before the change */
    // @ApiMember(Description="The value before the change")
    public OldValue?: string;

    /** @description The value after the change */
    // @ApiMember(Description="The value after the change")
    public NewValue?: string;

    /** @description The user who made the change */
    // @ApiMember(Description="The user who made the change")
    public ModifiedBy?: string;

    /** @description When the change was made */
    // @ApiMember(Description="When the change was made")
    public CreatedDate: string;

    public constructor(init?: Partial<SettingsChangeLogQueryResponse>) { (Object as any).assign(this, init); }
}

export class BaseModel
{

    public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}

export class SettingsChangeLog extends BaseModel implements IBaseModelCreated
{
    public Id: number;
    // @Required()
    public CompanyId: string;

    // @Required()
    // @StringLength(128)
    public SettingsType: string;

    // @Required()
    // @StringLength(256)
    public PropertyName: string;

    // @StringLength(2147483647)
    public OldValue?: string;

    // @StringLength(2147483647)
    public NewValue?: string;

    // @StringLength(256)
    public ModifiedBy?: string;

    // @Required()
    public CreatedDate: string;

    public ModifiedDate?: string;

    public constructor(init?: Partial<SettingsChangeLog>) { super(init); (Object as any).assign(this, init); }
}

// @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")
export class SettingsChangeLogQuery extends QueryDb<SettingsChangeLog, SettingsChangeLogQueryResponse> implements ICompany
{
    /** @description 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 CompanyId?: string;

    /** @description 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 SettingsType?: string;

    /** @description Filter by property name, e.g. SendEmailReminder */
    // @ApiMember(Description="Filter by property name, e.g. SendEmailReminder", ParameterType="query")
    public PropertyName?: string;

    /** @description Filter by who made the change */
    // @ApiMember(Description="Filter by who made the change", ParameterType="query")
    public ModifiedBy?: string;

    /** @description Filter changes created on or after this date */
    // @ApiMember(Description="Filter changes created on or after this date", ParameterType="query")
    public CreatedDateGreaterThanOrEqualTo?: string;

    /** @description Filter changes created on or before this date */
    // @ApiMember(Description="Filter changes created on or before this date", ParameterType="query")
    public CreatedDateLessThanOrEqualTo?: string;

    public constructor(init?: Partial<SettingsChangeLogQuery>) { super(init); (Object as any).assign(this, init); }
}

export class AccessKeyTypeResponse
{
    public Id: number;
    public KeyType: string;
    public Description: string;

    public constructor(init?: Partial<AccessKeyTypeResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public Offset: number;

    // @DataMember(Order=2)
    public Total: number;

    // @DataMember(Order=3)
    public Results: AccessKeyTypeResponse[] = [];

    // @DataMember(Order=4)
    public Meta?: { [index:string]: string; };

    // @DataMember(Order=5)
    public ResponseStatus?: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}

TypeScript 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>