BokaMera.API.Host

<back to all web services

UpdateVanderbiltCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/codelock/vanderbilt/settingsUpdate settings for the 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 CodeLockVanderbiltSettingResponse {
    /** @param {{CompanyId?:string,ApiEndpoint?:string,ApiPort?:number,Identifier?:string,DefaultFacilityId?:number,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 default identifier for the code lock. */
    Identifier;
    /**
     * @type {?number}
     * @description The default facility id to be used when no set on the resource. */
    DefaultFacilityId;
    /**
     * @type {string}
     * @description When settings was created */
    Created;
    /**
     * @type {string}
     * @description When settings was updated */
    Updated;
}
export class UpdateVanderbiltCodeLockSetting {
    /** @param {{CompanyId?:string,ApiEndpoint?:string,ApiPort?:string,Identifier?:string,DefaultFacilityId?: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 default identifier for the code lock. */
    Identifier;
    /**
     * @type {string}
     * @description The default facility id to be used when no set on the resource. */
    DefaultFacilityId;
}

JavaScript UpdateVanderbiltCodeLockSetting 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.

PUT /codelock/vanderbilt/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateVanderbiltCodeLockSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ApiEndpoint>String</ApiEndpoint>
  <ApiPort>String</ApiPort>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <DefaultFacilityId>String</DefaultFacilityId>
  <Identifier>String</Identifier>
</UpdateVanderbiltCodeLockSetting>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CodeLockVanderbiltSettingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ApiEndpoint>String</ApiEndpoint>
  <ApiPort>0</ApiPort>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <DefaultFacilityId>0</DefaultFacilityId>
  <Identifier>String</Identifier>
  <Updated>0001-01-01T00:00:00</Updated>
</CodeLockVanderbiltSettingResponse>