| 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. |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
class SiedleIntegrationType(IntEnum):
LOCAL_API = 1
CLOUD_BASED_API = 2
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CodeLockSiedleSettingResponse:
company_id: Optional[str] = None
# @ApiMember(DataType="string", Description="The api endpoint of the code lock")
api_endpoint: Optional[str] = None
"""
The api endpoint of the code lock
"""
# @ApiMember(DataType="string", Description="The api port for the code lock.")
api_port: Optional[int] = None
"""
The api port for the code lock.
"""
# @ApiMember(DataType="string", Description="The device id to the code lock.")
device_id: Optional[str] = None
"""
The device id to the code lock.
"""
# @ApiMember(DataType="string", Description="The username to logon to the code lock.")
username: Optional[str] = None
"""
The username to logon to the code lock.
"""
# @ApiMember(DataType="string", Description="The password to logon to the code lock.")
password: Optional[str] = None
"""
The password to logon to the code lock.
"""
# @ApiMember(DataType="string", Description="The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api")
integration_type: Optional[SiedleIntegrationType] = None
"""
The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api
"""
# @ApiMember(DataType="datetime", Description="When settings was created")
created: datetime.datetime = datetime.datetime(1, 1, 1)
"""
When settings was created
"""
# @ApiMember(DataType="datetime", Description="When settings was updated")
updated: datetime.datetime = datetime.datetime(1, 1, 1)
"""
When settings was updated
"""
# @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)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateSiedleCodeLockSetting(ICompany):
# @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
company_id: Optional[str] = None
"""
The company id, if empty will use the company id for the user you are logged in with.
"""
# @ApiMember(DataType="string", Description="The api endpoint of the code lock")
api_endpoint: Optional[str] = None
"""
The api endpoint of the code lock
"""
# @ApiMember(DataType="string", Description="The api port for the code lock.")
api_port: Optional[str] = None
"""
The api port for the code lock.
"""
# @ApiMember(DataType="string", Description="The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api")
integration_type: Optional[SiedleIntegrationType] = None
"""
The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api
"""
# @ApiMember(DataType="string", Description="The device id to the code lock.")
device_id: Optional[str] = None
"""
The device id to the code lock.
"""
# @ApiMember(DataType="string", Description="The username to logon to the code lock.")
username: Optional[str] = None
"""
The username to logon to the code lock.
"""
# @ApiMember(DataType="string", Description="The password to logon to the code lock.")
password: Optional[str] = None
"""
The password to logon to the code lock.
"""
Python UpdateSiedleCodeLockSetting DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateSiedleCodeLockSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<ApiEndpoint>String</ApiEndpoint>
<ApiPort>String</ApiPort>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<DeviceId>String</DeviceId>
<IntegrationType>LocalApi</IntegrationType>
<Password>String</Password>
<Username>String</Username>
</UpdateSiedleCodeLockSetting>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <CodeLockSiedleSettingResponse 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> <DeviceId>String</DeviceId> <IntegrationType>LocalApi</IntegrationType> <Password>String</Password> <Updated>0001-01-01T00:00:00</Updated> <Username>String</Username> </CodeLockSiedleSettingResponse>