BokaMera.API.Host

QueryAxemaUserSyncJobs

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read

The following routes are available for this service:
GET	/codelock/axema/usersync	Query Axema user sync jobs	Returns a list of sync jobs for the company, optionally filtered by status.

"use strict";
export class AxemaUserSyncJobResponse {
    /** @param {{Id?:string,CompanyId?:string,Status?:number,StatusName?:string,UsersFound?:number,UsersCreated?:number,UsersUpdated?:number,ErrorMessage?:string,CreatedDate?:string,UpdatedDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    CompanyId;
    /** @type {number} */
    Status;
    /** @type {string} */
    StatusName;
    /** @type {?number} */
    UsersFound;
    /** @type {?number} */
    UsersCreated;
    /** @type {?number} */
    UsersUpdated;
    /** @type {?string} */
    ErrorMessage;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    UpdatedDate;
}
export class QueryAxemaUserSyncJobsResponse {
    /** @param {{Results?:AxemaUserSyncJobResponse[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AxemaUserSyncJobResponse[]} */
    Results = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
/** @typedef {'Pending'|'Processing'|'Completed'|'Failed'} */
export var AxemaUserSyncStatus;
(function (AxemaUserSyncStatus) {
    AxemaUserSyncStatus["Pending"] = "Pending"
    AxemaUserSyncStatus["Processing"] = "Processing"
    AxemaUserSyncStatus["Completed"] = "Completed"
    AxemaUserSyncStatus["Failed"] = "Failed"
})(AxemaUserSyncStatus || (AxemaUserSyncStatus = {}));
export class QueryAxemaUserSyncJobs {
    /** @param {{CompanyId?:string,Status?:AxemaUserSyncStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {?AxemaUserSyncStatus}
     * @description Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed). */
    Status;
}

JavaScript QueryAxemaUserSyncJobs 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 /codelock/axema/usersync HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Results: 
	[
		{
			Status: 0,
			StatusName: String,
			UsersFound: 0,
			UsersCreated: 0,
			UsersUpdated: 0,
			ErrorMessage: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}