BokaMera.API.Host

<back to all web services

CodeLockSiedleSettingQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/codelock/siedle/settingsGet code lock api settings for the currently logged in userGet code lock api settings for 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
{
    [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 CodeLockSiedleSettingQuery
        : 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; }
    }

    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; }
    }

}

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

}

C# CodeLockSiedleSettingQuery DTOs

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

HTTP + JSV

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

GET /codelock/siedle/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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