BokaMera.API.Host

<back to all web services

CodeLockAxemaSettingQuery

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/settingsGet code lock api settings for the currently logged in userGet code lock api settings for the currently logged in user.
"use strict";
export class CodeLockAxemaSettingResponse {
    /** @param {{CompanyId?:string,ApiEndpoint?:string,ApiPort?:number,Username?:string,Password?:string,Created?:string,Updated?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /**
     * @type {string}
     * @description The api endpoint of the code lock */
    ApiEndpoint;
    /**
     * @type {number}
     * @description The api port for the code lock. */
    ApiPort;
    /**
     * @type {string}
     * @description The username to logon to the code lock. */
    Username;
    /**
     * @type {string}
     * @description The password to logon to the code lock. */
    Password;
    /**
     * @type {string}
     * @description When settings was created */
    Created;
    /**
     * @type {string}
     * @description When settings was updated */
    Updated;
}
export class CodeLockAxemaSettingQuery {
    /** @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 CodeLockAxemaSettingQuery 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/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ApiEndpoint: String,
	ApiPort: 0,
	Username: String,
	Password: String
}