BokaMera.API.Host

ReferenceQuery

The following routes are available for this service:
GET	/references	Get all valid references	Get all valid references.

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 QueryBase:
    skip: Optional[int] = None
    take: Optional[int] = None
    order_by: Optional[str] = None
    order_by_desc: Optional[str] = None
    include: Optional[str] = None
    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


From = TypeVar('From')
Into = TypeVar('Into')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb2(Generic[From, Into], QueryBase, IReturn[QueryResponse[Into]]):
    @staticmethod
    def response_type(): return QueryResponse[Into]


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReferenceQueryResponse:
    company_id: Optional[str] = None
    id: Optional[str] = None
    owner_id: Optional[str] = None
    reference_type: Optional[str] = None
    reference_type_id: int = 0
    external_data: Optional[str] = None
    updated: datetime.datetime = datetime.datetime(1, 1, 1)
    created: datetime.datetime = datetime.datetime(1, 1, 1)
    created_by: Optional[str] = None
    updated_by: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseModel:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExternalReference(BaseModel, IBaseModelCreated, IBaseModelUpdated):
    # @Required()
    company_id: Optional[str] = None

    # @Required()
    id: Optional[str] = None

    # @Required()
    owner_id: Optional[str] = None

    # @Required()
    reference_type: Optional[str] = None

    # @Required()
    reference_type_id: int = 0

    external_data: Optional[str] = None
    internal_data: Optional[str] = None
    created_by: Optional[str] = None
    # @Required()
    updated_date: datetime.datetime = datetime.datetime(1, 1, 1)

    # @Required()
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)

    modified_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReferenceQuery(QueryDb2[ExternalReference, ReferenceQueryResponse], 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(Description="Id of the reference")
    id: Optional[str] = None
    """
    Id of the reference
    """


    # @ApiMember(Description="Internal Id of the reference. Example could be the Booking Id")
    owner_id: Optional[str] = None
    """
    Internal Id of the reference. Example could be the Booking Id
    """


    # @ApiMember(Description="The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system")
    reference_type: Optional[str] = None
    """
    The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system
    """


    # @ApiMember(Description="The external data. Could be a Id or a JSON object or anything")
    external_data: Optional[str] = None
    """
    The external data. Could be a Id or a JSON object or anything
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AccessKeyTypeResponse:
    id: int = 0
    key_type: Optional[str] = None
    description: Optional[str] = None


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[T]):
    offset: int = 0
    total: int = 0
    results: List[AccessKeyTypeResponse] = field(default_factory=list)
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python ReferenceQuery 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 /references HTTP/1.1 
Host: api-staging.bookmore.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"ReferenceType":"String","ReferenceTypeId":0,"ExternalData":"String","CreatedBy":"String","UpdatedBy":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}