BokaMera.API.Host

<back to all web services

UpdateSiedleCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/codelock/siedle/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.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Enums;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class CodeLockSiedleSettingResponse
    {
        public virtual Guid CompanyId { get; set; }
        ///<summary>
        ///The api endpoint of the code lock
        ///</summary>
        [ApiMember(DataType="string", Description="The api endpoint of the code lock")]
        public virtual string ApiEndpoint { get; set; }

        ///<summary>
        ///The api port for the code lock.
        ///</summary>
        [ApiMember(DataType="string", Description="The api port for the code lock.")]
        public virtual int? ApiPort { get; set; }

        ///<summary>
        ///The device id to the code lock.
        ///</summary>
        [ApiMember(DataType="string", Description="The device id to the code lock.")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///The username to logon to the code lock.
        ///</summary>
        [ApiMember(DataType="string", Description="The username to logon to the code lock.")]
        public virtual string Username { get; set; }

        ///<summary>
        ///The password to logon to the code lock.
        ///</summary>
        [ApiMember(DataType="string", Description="The password to logon to the code lock.")]
        public virtual string Password { get; set; }

        ///<summary>
        ///The integration type to the code lock. 1 = Local Api,  2 = Cloud Based Api
        ///</summary>
        [ApiMember(DataType="string", Description="The integration type to the code lock. 1 = Local Api,  2 = Cloud Based Api")]
        public virtual SiedleIntegrationType IntegrationType { get; set; }

        ///<summary>
        ///When settings was created
        ///</summary>
        [ApiMember(DataType="datetime", Description="When settings was created")]
        public virtual DateTime Created { get; set; }

        ///<summary>
        ///When settings was updated
        ///</summary>
        [ApiMember(DataType="datetime", Description="When settings was updated")]
        public virtual DateTime Updated { get; set; }
    }

    [ValidateRequest("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)]
    public partial class UpdateSiedleCodeLockSetting
        : ICompany
    {
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///The api endpoint of the code lock
        ///</summary>
        [ApiMember(DataType="string", Description="The api endpoint of the code lock")]
        public virtual string ApiEndpoint { get; set; }

        ///<summary>
        ///The api port for the code lock.
        ///</summary>
        [ApiMember(DataType="string", Description="The api port for the code lock.")]
        public virtual string ApiPort { get; set; }

        ///<summary>
        ///The integration type to the code lock. 1 = Local Api,  2 = Cloud Based Api
        ///</summary>
        [ApiMember(DataType="string", Description="The integration type to the code lock. 1 = Local Api,  2 = Cloud Based Api")]
        public virtual SiedleIntegrationType IntegrationType { get; set; }

        ///<summary>
        ///The device id to the code lock.
        ///</summary>
        [ApiMember(DataType="string", Description="The device id to the code lock.")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///The username to logon to the code lock.
        ///</summary>
        [ApiMember(DataType="string", Description="The username to logon to the code lock.")]
        public virtual string Username { get; set; }

        ///<summary>
        ///The password to logon to the code lock.
        ///</summary>
        [ApiMember(DataType="string", Description="The password to logon to the code lock.")]
        public virtual string Password { get; set; }
    }

}

namespace BokaMera.API.ServiceModel.Enums
{
    public enum SiedleIntegrationType
    {
        LocalApi = 1,
        CloudBasedApi = 2,
    }

}

C# 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: testapi.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>