BokaMera.API.Host

<back to all web services

CodeLockVanderbiltSettingQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/codelock/vanderbilt/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 CodeLockVanderbiltSettingQuery
            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 CodeLockVanderbiltSettingResponse
            Public Overridable Property CompanyId As Guid
            '''<Summary>
            '''The api endpoint of the code lock
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The api endpoint of the code lock")>
            Public Overridable Property ApiEndpoint As String

            '''<Summary>
            '''The api port for the code lock.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The api port for the code lock.")>
            Public Overridable Property ApiPort As Integer

            '''<Summary>
            '''The default identifier for the code lock.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The default identifier for the code lock.")>
            Public Overridable Property Identifier As String

            '''<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 Overridable Property DefaultFacilityId As Nullable(Of Integer)

            '''<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 CodeLockVanderbiltSettingQuery DTOs

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

HTTP + XML

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

GET /codelock/vanderbilt/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CodeLockVanderbiltSettingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ApiEndpoint>String</ApiEndpoint>
  <ApiPort>0</ApiPort>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <DefaultFacilityId>0</DefaultFacilityId>
  <Identifier>String</Identifier>
  <Updated>0001-01-01T00:00:00</Updated>
</CodeLockVanderbiltSettingResponse>