Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /codelock/siedle/settings | Update settings for the code lock of the company of the currently logged in user | Update 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
Imports BokaMera.API.ServiceModel.Enums
Namespace Global
Namespace BokaMera.API.ServiceModel.Dtos
Public Partial Class CodeLockSiedleSettingResponse
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 Nullable(Of Integer)
'''<Summary>
'''The device id to the code lock.
'''</Summary>
<ApiMember(DataType:="string", Description:="The device id to the code lock.")>
Public Overridable Property DeviceId As String
'''<Summary>
'''The username to logon to the code lock.
'''</Summary>
<ApiMember(DataType:="string", Description:="The username to logon to the code lock.")>
Public Overridable Property Username As String
'''<Summary>
'''The password to logon to the code lock.
'''</Summary>
<ApiMember(DataType:="string", Description:="The password to logon to the code lock.")>
Public Overridable Property Password As String
'''<Summary>
'''The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api
'''</Summary>
<ApiMember(DataType:="string", Description:="The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api")>
Public Overridable Property IntegrationType As SiedleIntegrationType
'''<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
<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 UpdateSiedleCodeLockSetting
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")>
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 String
'''<Summary>
'''The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api
'''</Summary>
<ApiMember(DataType:="string", Description:="The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api")>
Public Overridable Property IntegrationType As SiedleIntegrationType
'''<Summary>
'''The device id to the code lock.
'''</Summary>
<ApiMember(DataType:="string", Description:="The device id to the code lock.")>
Public Overridable Property DeviceId As String
'''<Summary>
'''The username to logon to the code lock.
'''</Summary>
<ApiMember(DataType:="string", Description:="The username to logon to the code lock.")>
Public Overridable Property Username As String
'''<Summary>
'''The password to logon to the code lock.
'''</Summary>
<ApiMember(DataType:="string", Description:="The password to logon to the code lock.")>
Public Overridable Property Password As String
End Class
End Namespace
Namespace BokaMera.API.ServiceModel.Enums
Public Enum SiedleIntegrationType
LocalApi = 1
CloudBasedApi = 2
End Enum
End Namespace
End Namespace
VB.NET UpdateSiedleCodeLockSetting DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /codelock/siedle/settings HTTP/1.1
Host: api.bokamera.se
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","ApiEndpoint":"String","ApiPort":"String","IntegrationType":"LocalApi","DeviceId":"String","Username":"String","Password":"String"}
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"ApiEndpoint":"String","ApiPort":0,"DeviceId":"String","Username":"String","Password":"String","IntegrationType":"LocalApi"}