| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /homepage/menu | Update the homepage menu | Update the homepage menu on the company of the currently logged in user, only administrators are allowed to update homepage menu. |
|---|
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 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
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateHomepageMenu(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="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: Optional[bool] = None
"""
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: Optional[bool] = None
"""
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: Optional[bool] = None
"""
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: Optional[bool] = None
"""
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: Optional[bool] = None
"""
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: Optional[bool] = None
"""
If the my bookings menu item should be hidden
"""
# @ApiMember(Description="The text for calendar menu item")
calendar_text: Optional[str] = None
"""
The text for calendar menu item
"""
# @ApiMember(Description="If the calendar menu item should be hidden")
calendar_hidden: Optional[bool] = None
"""
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: Optional[bool] = None
"""
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
"""
Python UpdateHomepageMenu DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /homepage/menu HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
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
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
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
}
}
}