BokaMera.API.Host

<back to all web services

UpdateRcoM5CodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/codelock/rcom5/settingsUpdate settings for the RCO M5 code lock of the company of the currently logged in userUpdate settings for code lock of the company of the currently logged in user.
"use strict";
export class CodeLockRcoM5SettingResponse {
    /** @param {{CompanyId?:string,ApiEndpoint?:string,ServerId?:number,SystemName?:string,Username?:string,Password?:string,Created?:string,Updated?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /**
     * @type {string}
     * @description Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/). */
    ApiEndpoint;
    /**
     * @type {number}
     * @description Server id from rcoservers.config of the M5AdminAPI installation. */
    ServerId;
    /**
     * @type {string}
     * @description System name exactly as in R-CARD M5 Arbetsstation. */
    SystemName;
    /**
     * @type {string}
     * @description The API operator username to logon to the RCO M5 system. */
    Username;
    /**
     * @type {string}
     * @description The API operator password to logon to the RCO M5 system. */
    Password;
    /**
     * @type {string}
     * @description When settings were created */
    Created;
    /**
     * @type {string}
     * @description When settings were updated */
    Updated;
}
export class UpdateRcoM5CodeLockSetting {
    /** @param {{CompanyId?:string,ApiEndpoint?:string,ServerId?:number,SystemName?:string,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 Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/). */
    ApiEndpoint;
    /**
     * @type {number}
     * @description Server id from rcoservers.config of the M5AdminAPI installation. */
    ServerId;
    /**
     * @type {string}
     * @description System name exactly as in R-CARD M5 Arbetsstation. */
    SystemName;
    /**
     * @type {string}
     * @description The API operator username to logon to the RCO M5 system. */
    Username;
    /**
     * @type {string}
     * @description The API operator password to logon to the RCO M5 system. */
    Password;
}

JavaScript UpdateRcoM5CodeLockSetting DTOs

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

HTTP + CSV

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

PUT /codelock/rcom5/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","ApiEndpoint":"String","ServerId":0,"SystemName":"String","Username":"String","Password":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ApiEndpoint":"String","ServerId":0,"SystemName":"String","Username":"String","Password":"String"}