BokaMera.API.Host

<back to all web services

CodeLockParakeySettingQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/codelock/parakey/settingsGet code lock api settings for the currently logged in userGet code lock api settings for the currently logged in user.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <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)>
        Public Partial Class CodeLockParakeySettingQuery
            Implements 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 Overridable Property CompanyId As Nullable(Of Guid)
        End Class

        Public Partial Class CodeLockParakeySettingResponse
            Public Overridable Property CompanyId As Guid
            '''<Summary>
            '''The domain id of the code lock.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The domain id of the code lock.")>
            Public Overridable Property DomainId As String

            '''<Summary>
            '''The access token of the code lock.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The access token of the code lock.")>
            Public Overridable Property AccessToken As String

            '''<Summary>
            '''When settings was created
            '''</Summary>
            <ApiMember(DataType:="datetime", Description:="When settings was created")>
            Public Overridable Property Created As Date

            '''<Summary>
            '''When settings was updated
            '''</Summary>
            <ApiMember(DataType:="datetime", Description:="When settings was updated")>
            Public Overridable Property Updated As Date
        End Class
    End Namespace
End Namespace

VB.NET CodeLockParakeySettingQuery 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/parakey/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DomainId: String,
	AccessToken: String
}