| GET | /homepage/menu | Find 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
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: testapi.bokamera.se Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"HomeText":"String","HomeHidden":false,"ServicesText":"String","ServicesHidden":false,"BookTimeText":"String","BookTimeHidden":false,"AboutUsText":"String","AboutUsHidden":false,"ContactUsText":"String","ContactUsHidden":false,"MyBookingsText":"String","MyBookingsHidden":false,"CalendarText":"String","CalendarHidden":false,"NewsText":"String","NewsHidden":false,"AddressText":"String","AddressHidden":false,"GalleryText":"String","GalleryHidden":false,"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"}}}