BokaMera.API.Host

<back to all web services

CodeLockVanderbiltSettingQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/codelock/vanderbilt/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;

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 CodeLockVanderbiltSettingQuery
        : 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 CodeLockVanderbiltSettingResponse
    {
        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 default identifier for the code lock.
        ///</summary>
        [ApiMember(DataType="string", Description="The default identifier for the code lock.")]
        public virtual string Identifier { get; set; }

        ///<summary>
        ///The default facility id to be used when no set on the resource.
        ///</summary>
        [ApiMember(DataType="string", Description="The default facility id to be used when no set on the resource.")]
        public virtual int? DefaultFacilityId { 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; }
    }

}

C# CodeLockVanderbiltSettingQuery 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.

GET /codelock/vanderbilt/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
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>