BokaMera.API.Host

<back to all web services

CustomFieldSlotsQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/customfields/slotsFind all slots to store custom fields data inGet all available slots that are avaialble to store data in
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 CustomFieldSlotsQueryResponse:
    # @ApiMember(Description="Table to which the field belongs")
    table: Optional[str] = None
    """
    Table to which the field belongs
    """


    # @ApiMember(Description="Custom field id")
    id: int = 0
    """
    Custom field id
    """


    # @ApiMember(Description="Custom field column name")
    name: Optional[str] = None
    """
    Custom field column name
    """


    # @ApiMember(Description="The field datatype")
    datatype: Optional[str] = None
    """
    The field datatype
    """


    # @ApiMember(Description="If the slot is free or occupied")
    occupied: bool = False
    """
    If the slot is free or occupied
    """


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomFieldSlotsQuery(ICompany):
    # @ApiMember(Description="Company id to find custom fields for", ParameterType="query")
    company_id: Optional[str] = None
    """
    Company id to find custom fields for
    """


    # @ApiMember(Description="Table to which the field belongs", IsRequired=true)
    table: Optional[str] = None
    """
    Table to which the field belongs
    """


    # @ApiMember(Description="If you want to receive only free slots (not occupied).")
    free_slots: Optional[bool] = None
    """
    If you want to receive only free slots (not occupied).
    """

Python CustomFieldSlotsQuery DTOs

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

HTTP + CSV

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

GET /customfields/slots HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Table":"String","Id":0,"Name":"String","Datatype":"String","Occupied":false}