BokaMera.API.Host

<back to all web services

CodeLockIloqSettingQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/codelock/iloq/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.IO
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 CodeLockIloqSettingQuery
            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 Guid? Implements ICompany.CompanyId
        End Class

        Public Partial Class CodeLockIloqSettingResponse
            Public Overridable Property CompanyId As Guid
            '''<Summary>
            '''The iLOQ system identifier (e.g. ILOQ_21140)
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The iLOQ system identifier (e.g. ILOQ_21140)")>
            Public Overridable Property CustomerCode As String

            '''<Summary>
            '''The username to logon to the iLOQ system.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The username to logon to the iLOQ system.")>
            Public Overridable Property Username As String

            '''<Summary>
            '''The password to logon to the iLOQ system.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The password to logon to the iLOQ system.")>
            Public Overridable Property Password As String

            '''<Summary>
            '''The default Security Access name to use when no resource access group is specified.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The default Security Access name to use when no resource access group is specified.")>
            Public Overridable Property DefaultSecurityAccessName As String

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

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

VB.NET CodeLockIloqSettingQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /codelock/iloq/settings HTTP/1.1 
Host: api.bookmore.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"CustomerCode":"String","Username":"String","Password":"String","DefaultSecurityAccessName":"String"}