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

    [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 UpdateVanderbiltCodeLockSetting
        : 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 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 string DefaultFacilityId { get; set; }
    }

}

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

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

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	ApiEndpoint: String,
	ApiPort: String,
	Identifier: String,
	DefaultFacilityId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ApiEndpoint: String,
	ApiPort: 0,
	Identifier: String,
	DefaultFacilityId: 0
}