BokaMera.API.Host

<back to all web services

HomepageMenuQuery

The following routes are available for this service:
GET/homepage/menuFind news items for a company
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 QueryBase:
    skip: Optional[int] = None
    """
    Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
    """

    take: Optional[int] = None
    """
    Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
    """

    order_by: Optional[str] = None
    """
    Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
    """

    order_by_desc: Optional[str] = None
    """
    Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
    """

    include: Optional[str] = None
    """
    Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
    """

    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 HomepageMenuQueryResponse:
    # @ApiMember(Description="The company id")
    company_id: Optional[str] = None
    """
    The company id
    """


    # @ApiMember(Description="The text for home menu item")
    home_text: Optional[str] = None
    """
    The text for home menu item
    """


    # @ApiMember(Description="If the home menu item should be hidden")
    home_hidden: bool = False
    """
    If the home menu item should be hidden
    """


    # @ApiMember(Description="The text for services menu item")
    services_text: Optional[str] = None
    """
    The text for services menu item
    """


    # @ApiMember(Description="If the services menu item should be hidden")
    services_hidden: bool = False
    """
    If the services menu item should be hidden
    """


    # @ApiMember(Description="The text for book time menu item")
    book_time_text: Optional[str] = None
    """
    The text for book time menu item
    """


    # @ApiMember(Description="If the book time menu item should be hidden")
    book_time_hidden: bool = False
    """
    If the book time menu item should be hidden
    """


    # @ApiMember(Description="The text for about us menu item")
    about_us_text: Optional[str] = None
    """
    The text for about us menu item
    """


    # @ApiMember(Description="If the about us menu item should be hidden")
    about_us_hidden: bool = False
    """
    If the about us menu item should be hidden
    """


    # @ApiMember(Description="The text for contact us menu item")
    contact_us_text: Optional[str] = None
    """
    The text for contact us menu item
    """


    # @ApiMember(Description="If the contact us menu item should be hidden")
    contact_us_hidden: bool = False
    """
    If the contact us menu item should be hidden
    """


    # @ApiMember(Description="The text for my bookings menu item")
    my_bookings_text: Optional[str] = None
    """
    The text for my bookings menu item
    """


    # @ApiMember(Description="If the my bookings menu item should be hidden")
    my_bookings_hidden: bool = False
    """
    If the my bookings menu item should be hidden
    """


    # @ApiMember(Description="The text for calender menu item")
    calendar_text: Optional[str] = None
    """
    The text for calender menu item
    """


    # @ApiMember(Description="If the calendar menu item should be hidden")
    calendar_hidden: bool = False
    """
    If the calendar menu item should be hidden
    """


    # @ApiMember(Description="The text for news menu item")
    news_text: Optional[str] = None
    """
    The text for news menu item
    """


    # @ApiMember(Description="If the news menu item should be hidden")
    news_hidden: bool = False
    """
    If the news menu item should be hidden
    """


    # @ApiMember(Description="The text for address menu item")
    address_text: Optional[str] = None
    """
    The text for address menu item
    """


    # @ApiMember(Description="If the address menu item should be hidden")
    address_hidden: Optional[bool] = None
    """
    If the address menu item should be hidden
    """


    # @ApiMember(Description="The text for gallery menu item")
    gallery_text: Optional[str] = None
    """
    The text for gallery menu item
    """


    # @ApiMember(Description="If the gallery menu item should be hidden")
    gallery_hidden: Optional[bool] = None
    """
    If the gallery menu item should be hidden
    """


    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 HomepageMenu(BaseModel):
    # @Required()
    home_text: Optional[str] = None

    # @Required()
    home_hidden: bool = False

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

    # @Required()
    services_hidden: bool = False

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

    # @Required()
    book_time_hidden: bool = False

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

    # @Required()
    about_us_hidden: bool = False

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

    # @Required()
    contact_us_hidden: bool = False

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

    # @Required()
    my_bookings_hidden: bool = False

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

    # @Required()
    calendar_hidden: bool = False

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

    # @Required()
    news_hidden: bool = False

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

    # @Required()
    address_hidden: bool = False

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

    # @Required()
    gallery_hidden: bool = False

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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HomepageMenuQuery(QueryDb2[HomepageMenu, HomepageMenuQueryResponse], ICompanyRequest):
    # @ApiMember(Description="Enter the company you want to see news for, if blank and you are an admin, your company id will be used", ParameterType="query")
    company_id: Optional[str] = None
    """
    Enter the company you want to see news for, if blank and you are an admin, your company id will be used
    """


    # @ApiMember(Description="The homeage sitepath.")
    site_path: Optional[str] = None
    """
    The homeage sitepath.
    """


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


AccessKeyTypeResponse = TypeVar('AccessKeyTypeResponse')


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

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

GET /homepage/menu HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfHomepageMenuQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
    <d2p1:HomepageMenuQueryResponse>
      <d2p1:AboutUsHidden>false</d2p1:AboutUsHidden>
      <d2p1:AboutUsText>String</d2p1:AboutUsText>
      <d2p1:AddressHidden>false</d2p1:AddressHidden>
      <d2p1:AddressText>String</d2p1:AddressText>
      <d2p1:BookTimeHidden>false</d2p1:BookTimeHidden>
      <d2p1:BookTimeText>String</d2p1:BookTimeText>
      <d2p1:CalendarHidden>false</d2p1:CalendarHidden>
      <d2p1:CalendarText>String</d2p1:CalendarText>
      <d2p1:CompanyId>00000000-0000-0000-0000-000000000000</d2p1:CompanyId>
      <d2p1:ContactUsHidden>false</d2p1:ContactUsHidden>
      <d2p1:ContactUsText>String</d2p1:ContactUsText>
      <d2p1:GalleryHidden>false</d2p1:GalleryHidden>
      <d2p1:GalleryText>String</d2p1:GalleryText>
      <d2p1:HomeHidden>false</d2p1:HomeHidden>
      <d2p1:HomeText>String</d2p1:HomeText>
      <d2p1:MyBookingsHidden>false</d2p1:MyBookingsHidden>
      <d2p1:MyBookingsText>String</d2p1:MyBookingsText>
      <d2p1:NewsHidden>false</d2p1:NewsHidden>
      <d2p1:NewsText>String</d2p1:NewsText>
      <d2p1:ResponseStatus>
        <ErrorCode>String</ErrorCode>
        <Message>String</Message>
        <StackTrace>String</StackTrace>
        <Errors>
          <ResponseError>
            <ErrorCode>String</ErrorCode>
            <FieldName>String</FieldName>
            <Message>String</Message>
            <Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </Meta>
          </ResponseError>
        </Errors>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </d2p1:ResponseStatus>
      <d2p1:ServicesHidden>false</d2p1:ServicesHidden>
      <d2p1:ServicesText>String</d2p1:ServicesText>
    </d2p1:HomepageMenuQueryResponse>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfHomepageMenuQueryResponseWg5EthtI>