BokaMera.API.Host

<back to all web services

AddVanderbiltCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/codelock/vanderbilt/settingsAdd settings for the code lock of the company of the currently logged in userAdd settings for code lock of the company of 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 AddVanderbiltCodeLockSetting
            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)

            '''<Summary>
            '''The api endpoint of the code lock
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The api endpoint of the code lock", IsRequired:=true)>
            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.", IsRequired:=true)>
            Public Overridable Property ApiPort As String

            '''<Summary>
            '''The default identifier for the code lock.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The default identifier for the code lock.", IsRequired:=true)>
            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 String
        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 AddVanderbiltCodeLockSetting 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.

POST /codelock/vanderbilt/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","ApiEndpoint":"String","ApiPort":"String","Identifier":"String","DefaultFacilityId":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ApiEndpoint":"String","ApiPort":0,"Identifier":"String","DefaultFacilityId":0}