BokaMera.API.Host

<back to all web services

UpdateVanderbiltCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/codelock/vanderbilt/settingsUpdate settings for the 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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CodeLockVanderbiltSettingResponse:
    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: int = 0
    """
    The api port for the code lock.
    """


    # @ApiMember(DataType="string", Description="The default identifier for the code lock.")
    identifier: Optional[str] = None
    """
    The default identifier for the code lock.
    """


    # @ApiMember(DataType="string", Description="The default facility id to be used when no set on the resource.")
    default_facility_id: Optional[int] = None
    """
    The default facility id to be used when no set on the resource.
    """


    # @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 UpdateVanderbiltCodeLockSetting(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 default identifier for the code lock.")
    identifier: Optional[str] = None
    """
    The default identifier for the code lock.
    """


    # @ApiMember(DataType="string", Description="The default facility id to be used when no set on the resource.")
    default_facility_id: Optional[str] = None
    """
    The default facility id to be used when no set on the resource.
    """

Python UpdateVanderbiltCodeLockSetting DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /codelock/vanderbilt/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length

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