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 .jsv suffix or ?format=jsv

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