BokaMera.API.Host

<back to all web services

CodeLockZesecSettingQuery

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

    [<AllowNullLiteral>]
    type CodeLockZesecSettingResponse() = 
        member val CompanyId:Guid = new Guid() with get,set
        ///<summary>
        ///The username (phone number) for login to the code lock
        ///</summary>
        [<ApiMember(DataType="string", Description="The username (phone number) for login to the code lock")>]
        member val PhoneNumber:String = null with get,set

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

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

        ///<summary>
        ///When settings were updated
        ///</summary>
        [<ApiMember(DataType="datetime", Description="When settings were 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 CodeLockZesecSettingQuery() = 
        ///<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

F# CodeLockZesecSettingQuery 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/zesec/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	PhoneNumber: String,
	Password: String
}