BokaMera.API.Host

<back to all web services

AddSiedleCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/codelock/siedle/settingsAdd settings for the code lock of the company of the currently logged in userAdd settings for code lock of the company of the currently logged in user.
"use strict";
/** @typedef {number} */
export var SiedleIntegrationType;
(function (SiedleIntegrationType) {
    SiedleIntegrationType[SiedleIntegrationType["LocalApi"] = 1] = "LocalApi"
    SiedleIntegrationType[SiedleIntegrationType["CloudBasedApi"] = 2] = "CloudBasedApi"
})(SiedleIntegrationType || (SiedleIntegrationType = {}));
export class CodeLockSiedleSettingResponse {
    /** @param {{CompanyId?:string,ApiEndpoint?:string,ApiPort?:number,DeviceId?:string,Username?:string,Password?:string,IntegrationType?:SiedleIntegrationType,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 device id to the code lock. */
    DeviceId;
    /**
     * @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 {SiedleIntegrationType}
     * @description The integration type to the code lock. 1 = Local Api,  2 = Cloud Based Api */
    IntegrationType;
    /**
     * @type {string}
     * @description When settings was created */
    Created;
    /**
     * @type {string}
     * @description When settings was updated */
    Updated;
}
export class AddSiedleCodeLockSetting {
    /** @param {{CompanyId?:string,ApiEndpoint?:string,ApiPort?:string,DeviceId?:string,IntegrationType?:SiedleIntegrationType,Username?:string,Password?: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;
    /**
     * @type {string}
     * @description The api endpoint of the code lock */
    ApiEndpoint;
    /**
     * @type {string}
     * @description The api port for the code lock. */
    ApiPort;
    /**
     * @type {string}
     * @description The device id to the code lock. */
    DeviceId;
    /**
     * @type {SiedleIntegrationType}
     * @description The integration type to the code lock. 1 = Local Api,  2 = Cloud Based Api */
    IntegrationType;
    /**
     * @type {string}
     * @description The username to logon to the code lock. */
    Username;
    /**
     * @type {string}
     * @description The password to logon to the code lock. */
    Password;
}

JavaScript AddSiedleCodeLockSetting DTOs

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

HTTP + OTHER

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

POST /codelock/siedle/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","ApiEndpoint":"String","ApiPort":"String","DeviceId":"String","IntegrationType":"LocalApi","Username":"String","Password":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ApiEndpoint":"String","ApiPort":0,"DeviceId":"String","Username":"String","Password":"String","IntegrationType":"LocalApi"}