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.
SettingsChangeLogQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
SettingsTypequerystringNoFilter by settings type, e.g. BookingSettings, PaymentSettings, CompanySetting, EAccountingSettings
PropertyNamequerystringNoFilter by property name, e.g. SendEmailReminder
ModifiedByquerystringNoFilter by who made the change
CreatedDateGreaterThanOrEqualToqueryDateTime?NoFilter changes created on or after this date
CreatedDateLessThanOrEqualToqueryDateTime?NoFilter changes created on or before this date
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SettingsChangeLog Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CompanyIdformGuidYes
SettingsTypeformstringYes
PropertyNameformstringYes
OldValueformstringNo
NewValueformstringNo
ModifiedByformstringNo
CreatedDateformDateTimeYes
ModifiedDateformDateTimeOffset?No
SettingsChangeLogQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe change log entry id
CompanyIdformGuidNoThe company id
SettingsTypeformstringYesThe settings type that was changed, e.g. BookingSettings
PropertyNameformstringYesThe property name that was changed
OldValueformstringNoThe value before the change
NewValueformstringNoThe value after the change
ModifiedByformstringNoThe user who made the change
CreatedDateformDateTimeNoWhen the change was made
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>Yes
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringYes
DescriptionformstringYes

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