BokaMera.API.Host

<back to all web services

CreateAxemaUserSync

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/codelock/axema/usersyncStart a sync of users from the Axema Vaka system into BokaMera customersThis operation runs in the background and may take several minutes. Use the GET endpoint to check status. Only one sync can run at a time per company.
"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 CreateAxemaUserSync {
    /** @param {{CompanyId?:string}} [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;
}

JavaScript CreateAxemaUserSync DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /codelock/axema/usersync HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Status":0,"StatusName":"String","UsersFound":0,"UsersCreated":0,"UsersUpdated":0,"ErrorMessage":"String"}