BokaMera.API.Host

<back to all web services

GetAxemaUserSyncJob

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/{Id}Get a single Axema user sync job by idReturns the sync job details including progress counters.
"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 GetAxemaUserSyncJob {
    /** @param {{Id?:string,CompanyId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The sync job id. */
    Id;
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
}

JavaScript GetAxemaUserSyncJob 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 /codelock/axema/usersync/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AxemaUserSyncJobResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <ErrorMessage>String</ErrorMessage>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <Status>0</Status>
  <StatusName>String</StatusName>
  <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
  <UsersCreated>0</UsersCreated>
  <UsersFound>0</UsersFound>
  <UsersUpdated>0</UsersUpdated>
</AxemaUserSyncJobResponse>