BokaMera.API.Host

UpdateSiedleCodeLockSetting

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
PUT	/codelock/siedle/settings	Update settings for the code lock of the company of the currently logged in user	Update settings for code lock of the company of the currently logged in user.


export enum SiedleIntegrationType
{
    LocalApi = 1,
    CloudBasedApi = 2,
}

export class CodeLockSiedleSettingResponse
{
    public CompanyId: string;
    /** @description The api endpoint of the code lock */
    // @ApiMember(DataType="string", Description="The api endpoint of the code lock")
    public ApiEndpoint: string;

    /** @description The api port for the code lock. */
    // @ApiMember(DataType="string", Description="The api port for the code lock.")
    public ApiPort?: number;

    /** @description The device id to the code lock. */
    // @ApiMember(DataType="string", Description="The device id to the code lock.")
    public DeviceId: string;

    /** @description The username to logon to the code lock. */
    // @ApiMember(DataType="string", Description="The username to logon to the code lock.")
    public Username: string;

    /** @description The password to logon to the code lock. */
    // @ApiMember(DataType="string", Description="The password to logon to the code lock.")
    public Password: string;

    /** @description The integration type to the code lock. 1 = Local Api,  2 = Cloud Based Api */
    // @ApiMember(DataType="string", Description="The integration type to the code lock. 1 = Local Api,  2 = Cloud Based Api")
    public IntegrationType: SiedleIntegrationType;

    /** @description When settings was created */
    // @ApiMember(DataType="datetime", Description="When settings was created")
    public Created: string;

    /** @description When settings was updated */
    // @ApiMember(DataType="datetime", Description="When settings was updated")
    public Updated: string;

    public constructor(init?: Partial<CodeLockSiedleSettingResponse>) { (Object as any).assign(this, init); }
}

// @ValidateRequest(Validator="IsAuthenticated")
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privileges to call this service", StatusCode=403)
export class UpdateSiedleCodeLockSetting implements ICompany
{
    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public CompanyId?: string;

    /** @description The api endpoint of the code lock */
    // @ApiMember(DataType="string", Description="The api endpoint of the code lock")
    public ApiEndpoint: string;

    /** @description The api port for the code lock. */
    // @ApiMember(DataType="string", Description="The api port for the code lock.")
    public ApiPort: string;

    /** @description The integration type to the code lock. 1 = Local Api,  2 = Cloud Based Api */
    // @ApiMember(DataType="string", Description="The integration type to the code lock. 1 = Local Api,  2 = Cloud Based Api")
    public IntegrationType: SiedleIntegrationType;

    /** @description The device id to the code lock. */
    // @ApiMember(DataType="string", Description="The device id to the code lock.")
    public DeviceId: string;

    /** @description The username to logon to the code lock. */
    // @ApiMember(DataType="string", Description="The username to logon to the code lock.")
    public Username: string;

    /** @description The password to logon to the code lock. */
    // @ApiMember(DataType="string", Description="The password to logon to the code lock.")
    public Password: string;

    public constructor(init?: Partial<UpdateSiedleCodeLockSetting>) { (Object as any).assign(this, init); }
}

TypeScript UpdateSiedleCodeLockSetting 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/siedle/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateSiedleCodeLockSetting 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>
  <DeviceId>String</DeviceId>
  <IntegrationType>LocalApi</IntegrationType>
  <Password>String</Password>
  <Username>String</Username>
</UpdateSiedleCodeLockSetting>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CodeLockSiedleSettingResponse 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>
  <DeviceId>String</DeviceId>
  <IntegrationType>LocalApi</IntegrationType>
  <Password>String</Password>
  <Updated>0001-01-01T00:00:00</Updated>
  <Username>String</Username>
</CodeLockSiedleSettingResponse>