BokaMera.API.Host

<back to all web services

UpdateIloqCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/codelock/iloq/settingsUpdate settings for the iLOQ S50 code lock of the company of the currently logged in userUpdate 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 CodeLockIloqSettingResponse:
    company_id: Optional[str] = None
    # @ApiMember(DataType="string", Description="The iLOQ system identifier (e.g. ILOQ_21140)")
    customer_code: Optional[str] = None
    """
    The iLOQ system identifier (e.g. ILOQ_21140)
    """


    # @ApiMember(DataType="string", Description="The username to logon to the iLOQ system.")
    username: Optional[str] = None
    """
    The username to logon to the iLOQ system.
    """


    # @ApiMember(DataType="string", Description="The password to logon to the iLOQ system.")
    password: Optional[str] = None
    """
    The password to logon to the iLOQ system.
    """


    # @ApiMember(DataType="string", Description="The default Security Access name to use when no resource access group is specified.")
    default_security_access_name: Optional[str] = None
    """
    The default Security Access name to use when no resource access group is specified.
    """


    # @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 UpdateIloqCodeLockSetting(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 iLOQ system identifier (e.g. ILOQ_21140)")
    customer_code: Optional[str] = None
    """
    The iLOQ system identifier (e.g. ILOQ_21140)
    """


    # @ApiMember(DataType="string", Description="The username to logon to the iLOQ system.")
    username: Optional[str] = None
    """
    The username to logon to the iLOQ system.
    """


    # @ApiMember(DataType="string", Description="The password to logon to the iLOQ system.")
    password: Optional[str] = None
    """
    The password to logon to the iLOQ system.
    """


    # @ApiMember(DataType="string", Description="The default Security Access name to use when no resource access group is specified.")
    default_security_access_name: Optional[str] = None
    """
    The default Security Access name to use when no resource access group is specified.
    """

Python UpdateIloqCodeLockSetting 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.

PUT /codelock/iloq/settings HTTP/1.1 
Host: api.bookmore.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateIloqCodeLockSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CustomerCode>String</CustomerCode>
  <DefaultSecurityAccessName>String</DefaultSecurityAccessName>
  <Password>String</Password>
  <Username>String</Username>
</UpdateIloqCodeLockSetting>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CodeLockIloqSettingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <CustomerCode>String</CustomerCode>
  <DefaultSecurityAccessName>String</DefaultSecurityAccessName>
  <Password>String</Password>
  <Updated>0001-01-01T00:00:00</Updated>
  <Username>String</Username>
</CodeLockIloqSettingResponse>