| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /codelock/rcom5/settings | Add settings for the RCO M5 code lock of the company of the currently logged in user | Add 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
Object = TypeVar('Object')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CodeLockRcoM5SettingResponse:
company_id: Optional[str] = None
# @ApiMember(DataType="string", Description="Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).")
api_endpoint: Optional[str] = None
"""
Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).
"""
# @ApiMember(DataType="int", Description="Server id from rcoservers.config of the M5AdminAPI installation.")
server_id: int = 0
"""
Server id from rcoservers.config of the M5AdminAPI installation.
"""
# @ApiMember(DataType="string", Description="System name exactly as in R-CARD M5 Arbetsstation.")
system_name: Optional[str] = None
"""
System name exactly as in R-CARD M5 Arbetsstation.
"""
# @ApiMember(DataType="string", Description="The API operator username to logon to the RCO M5 system.")
username: Optional[str] = None
"""
The API operator username to logon to the RCO M5 system.
"""
# @ApiMember(DataType="string", Description="The API operator password to logon to the RCO M5 system.")
password: Optional[str] = None
"""
The API operator password to logon to the RCO M5 system.
"""
# @ApiMember(DataType="datetime", Description="When settings were created")
created: datetime.datetime = datetime.datetime(1, 1, 1)
"""
When settings were created
"""
# @ApiMember(DataType="datetime", Description="When settings were updated")
updated: datetime.datetime = datetime.datetime(1, 1, 1)
"""
When settings were 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 AddRcoM5CodeLockSetting(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="Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).")
api_endpoint: Optional[str] = None
"""
Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).
"""
# @ApiMember(DataType="int", Description="Server id from rcoservers.config of the M5AdminAPI installation.", IsRequired=true)
server_id: int = 0
"""
Server id from rcoservers.config of the M5AdminAPI installation.
"""
# @ApiMember(DataType="string", Description="System name exactly as in R-CARD M5 Arbetsstation.", IsRequired=true)
system_name: Optional[str] = None
"""
System name exactly as in R-CARD M5 Arbetsstation.
"""
# @ApiMember(DataType="string", Description="The API operator username to logon to the RCO M5 system.", IsRequired=true)
username: Optional[str] = None
"""
The API operator username to logon to the RCO M5 system.
"""
# @ApiMember(DataType="string", Description="The API operator password to logon to the RCO M5 system.", IsRequired=true)
password: Optional[str] = None
"""
The API operator password to logon to the RCO M5 system.
"""
Python AddRcoM5CodeLockSetting 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.
POST /codelock/rcom5/settings HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AddRcoM5CodeLockSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<ApiEndpoint>String</ApiEndpoint>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Password>String</Password>
<ServerId>0</ServerId>
<SystemName>String</SystemName>
<Username>String</Username>
</AddRcoM5CodeLockSetting>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <CodeLockRcoM5SettingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <ApiEndpoint>String</ApiEndpoint> <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId> <Created>0001-01-01T00:00:00</Created> <Password>String</Password> <ServerId>0</ServerId> <SystemName>String</SystemName> <Updated>0001-01-01T00:00:00</Updated> <Username>String</Username> </CodeLockRcoM5SettingResponse>