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.
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type SiedleIntegrationType =
        | LocalApi = 1
        | CloudBasedApi = 2

    [<AllowNullLiteral>]
    type CodeLockSiedleSettingResponse() = 
        member val CompanyId:Guid = new Guid() with get,set
        ///<summary>
        ///The api endpoint of the code lock
        ///</summary>
        [<ApiMember(DataType="string", Description="The api endpoint of the code lock")>]
        member val ApiEndpoint:String = null with get,set

        ///<summary>
        ///The api port for the code lock.
        ///</summary>
        [<ApiMember(DataType="string", Description="The api port for the code lock.")>]
        member val ApiPort:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///The device id to the code lock.
        ///</summary>
        [<ApiMember(DataType="string", Description="The device id to the code lock.")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///The username to logon to the code lock.
        ///</summary>
        [<ApiMember(DataType="string", Description="The username to logon to the code lock.")>]
        member val Username:String = null with get,set

        ///<summary>
        ///The password to logon to the code lock.
        ///</summary>
        [<ApiMember(DataType="string", Description="The password to logon to the code lock.")>]
        member val Password:String = null with 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")>]
        member val IntegrationType:SiedleIntegrationType = new SiedleIntegrationType() with get,set

        ///<summary>
        ///When settings was created
        ///</summary>
        [<ApiMember(DataType="datetime", Description="When settings was created")>]
        member val Created:DateTime = new DateTime() with get,set

        ///<summary>
        ///When settings was updated
        ///</summary>
        [<ApiMember(DataType="datetime", Description="When settings was updated")>]
        member val Updated:DateTime = new DateTime() with get,set

    [<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)>]
    [<AllowNullLiteral>]
    type UpdateSiedleCodeLockSetting() = 
        ///<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.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///The api endpoint of the code lock
        ///</summary>
        [<ApiMember(DataType="string", Description="The api endpoint of the code lock")>]
        member val ApiEndpoint:String = null with get,set

        ///<summary>
        ///The api port for the code lock.
        ///</summary>
        [<ApiMember(DataType="string", Description="The api port for the code lock.")>]
        member val ApiPort:String = null with 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")>]
        member val IntegrationType:SiedleIntegrationType = new SiedleIntegrationType() with get,set

        ///<summary>
        ///The device id to the code lock.
        ///</summary>
        [<ApiMember(DataType="string", Description="The device id to the code lock.")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///The username to logon to the code lock.
        ///</summary>
        [<ApiMember(DataType="string", Description="The username to logon to the code lock.")>]
        member val Username:String = null with get,set

        ///<summary>
        ///The password to logon to the code lock.
        ///</summary>
        [<ApiMember(DataType="string", Description="The password to logon to the code lock.")>]
        member val Password:String = null with get,set

F# UpdateSiedleCodeLockSetting 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/siedle/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,
	IntegrationType: LocalApi,
	DeviceId: String,
	Username: String,
	Password: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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