BokaMera.API.Host

<back to all web services

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/usersyncQuery Axema user sync jobsReturns 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 .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 HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryAxemaUserSyncJobsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Results>
    <AxemaUserSyncJobResponse>
      <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>
  </Results>
</QueryAxemaUserSyncJobsResponse>