| POST | /users/favorite | Add an company as favorite to the logged in user | Add an company as favorite to the logged in user. |
|---|
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
class CodeLockSystemType(str, Enum):
SAMPLE = 'Sample'
RCO_M5 = 'RcoM5'
AXEMA_VAKA = 'AxemaVaka'
VANDERBILT_OMNIS = 'VanderbiltOmnis'
PARAKEY_PARAKEY = 'ParakeyParakey'
AMIDO_DAX = 'AmidoDax'
TELKEY_TELKEY = 'TelkeyTelkey'
TECH_SOLUTIONS_SIEDLE = 'TechSolutionsSiedle'
ACCESSY = 'Accessy'
ZESEC = 'Zesec'
ENABLA = 'Enabla'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompanyBookingSettings:
enable_mobile_app: bool = False
booking_receipt_message: Optional[str] = None
show_free_times_left: bool = False
enable_show_booked_times: bool = False
booking_agreement: Optional[str] = None
# @ApiMember(DataType="int", Description="The settings for how to display week number. 1 = ShowWeekNumberFromDate, 2 = ShowWeekNumberToDate, 3 = ShowWeekNumberFromToDate, 4 = DontShowWeekNumber ")
week_number_setting: int = 0
"""
The settings for how to display week number. 1 = ShowWeekNumberFromDate, 2 = ShowWeekNumberToDate, 3 = ShowWeekNumberFromToDate, 4 = DontShowWeekNumber
"""
show_booked_times: bool = False
# @ApiMember(Description="The payment provider id. To get the full payment provider for the company call GET /payment/settings")
payment_provider_id: int = 0
"""
The payment provider id. To get the full payment provider for the company call GET /payment/settings
"""
# @ApiMember(DataType="boolean", Description="If it's only allowed for existing customers to book")
book_only_on_existing_customers: bool = False
"""
If it's only allowed for existing customers to book
"""
# @ApiMember(DataType="boolean", Description="If payment is enabled")
payment_enabled: bool = False
"""
If payment is enabled
"""
booking_pin_code_restriction: Optional[str] = None
customer_invoice_adress_required: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompanySystemSettings:
# @ApiMember(DataType="bool", Description="If the booking is active or not")
active: bool = False
"""
If the booking is active or not
"""
# @ApiMember(DataType="string", Description="If the booking is not active, what message to show to the customers")
inactive_message: Optional[str] = None
"""
If the booking is not active, what message to show to the customers
"""
# @ApiMember(DataType="bool", Description="If the company should be visible in search results on homepage")
searchable: bool = False
"""
If the company should be visible in search results on homepage
"""
# @ApiMember(DataType="string", Description="If you have a Google Analytics account and want to track your customers behaviors.")
ga_tracking_id: Optional[str] = None
"""
If you have a Google Analytics account and want to track your customers behaviors.
"""
# @ApiMember(DataType="string", Description="If you have a Google Ads Conversion Id account and want to track your customers behaviors.")
google_ads_conversion_id: Optional[str] = None
"""
If you have a Google Ads Conversion Id account and want to track your customers behaviors.
"""
# @ApiMember(DataType="string", Description="If you have a LinkedIn account and want to track your customers behaviors.")
linkedin_tag_id: Optional[str] = None
"""
If you have a LinkedIn account and want to track your customers behaviors.
"""
# @ApiMember(DataType="string", Description="If you have a Google Ads Conversion Label and want to track your customers behaviors.")
google_ads_conversion_label: Optional[str] = None
"""
If you have a Google Ads Conversion Label and want to track your customers behaviors.
"""
# @ApiMember(DataType="string", Description="If you have a Google Tag Manager account and want to track your customers behaviors.")
gtm_tracking_id: Optional[str] = None
"""
If you have a Google Tag Manager account and want to track your customers behaviors.
"""
# @ApiMember(DataType="string", Description="If you have a Facebook account and want to track your customers behaviors.")
facebook_pixel_id: Optional[str] = None
"""
If you have a Facebook account and want to track your customers behaviors.
"""
# @ApiMember(DataType="bool", Description="If you want your customers to be able to change language on your homepage")
multi_language: bool = False
"""
If you want your customers to be able to change language on your homepage
"""
# @ApiMember(DataType="bool", Description="If the company should be visible on the marketplace")
show_on_marketplace: bool = False
"""
If the company should be visible on the marketplace
"""
# @ApiMember(DataType="bool", Description="If you want your own written text on your homepage to be translated using Google Translate when a user changes language")
enable_a_p_i_translation: bool = False
"""
If you want your own written text on your homepage to be translated using Google Translate when a user changes language
"""
# @ApiMember(DataType="string", Description="What is the standard language your homepage information is written in. Select from the different countries, i.e. SE,NO,EN")
default_language: Optional[str] = None
"""
What is the standard language your homepage information is written in. Select from the different countries, i.e. SE,NO,EN
"""
# @ApiMember(Description="If you want to allow to send customer information in the tracking events to the external providers. Note you as a company are responsible for informing your customers and handling the data in terms of GDPR. ")
send_customer_information_to_external_providers: bool = False
"""
If you want to allow to send customer information in the tracking events to the external providers. Note you as a company are responsible for informing your customers and handling the data in terms of GDPR.
"""
# @ApiMember(Description="The maximum number of SMS messages that can be sent per day.")
sms_message_daily_send_limit: int = 0
"""
The maximum number of SMS messages that can be sent per day.
"""
# @ApiMember(Description="The maximum number of email messages that can be sent per day.")
email_message_daily_send_limit: int = 0
"""
The maximum number of email messages that can be sent per day.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompanyWidgetSettings:
# @ApiMember(Description="The service layouts id.")
service_layout_id: int = 0
"""
The service layouts id.
"""
# @ApiMember(Description="The time layouts id.")
time_layout_id: int = 0
"""
The time layouts id.
"""
# @ApiMember(Description="The booking layouts id.")
booking_layout_id: int = 0
"""
The booking layouts id.
"""
# @ApiMember(Description="The primary color of the booking widget.")
primary_color: Optional[str] = None
"""
The primary color of the booking widget.
"""
# @ApiMember(Description="If you should show the service image in the booking widget.")
show_service_image: bool = False
"""
If you should show the service image in the booking widget.
"""
# @ApiMember(Description="If you should show the rebate code field in the booking widget.")
show_rebate_code_field: bool = False
"""
If you should show the rebate code field in the booking widget.
"""
# @ApiMember(Description="If you should show the next available time in the booking widget.")
show_next_available_time: bool = False
"""
If you should show the next available time in the booking widget.
"""
# @ApiMember(Description="If you should show the end time in the booking widget.")
show_end_time: bool = False
"""
If you should show the end time in the booking widget.
"""
# @ApiMember(Description="What text to show on booked time slots. Default text is Booked")
booked_time_slot_text: Optional[str] = None
"""
What text to show on booked time slots. Default text is Booked
"""
# @ApiMember(Description="If the widget should be displayed in dark theme")
dark_theme: bool = False
"""
If the widget should be displayed in dark theme
"""
# @ApiMember(Description="If you should show the subscribe to newsletter checkbox in the booking widget.")
show_subscribe_to_newsletter: bool = False
"""
If you should show the subscribe to newsletter checkbox in the booking widget.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HomepageSettingsResponse:
# @ApiMember(Description="The text for homepage heading")
homepage_heading: Optional[str] = None
"""
The text for homepage heading
"""
# @ApiMember(Description="The text for homepage startpage heading")
welcome_page_heading: Optional[str] = None
"""
The text for homepage startpage heading
"""
# @ApiMember(Description="The text for homepage startpage body")
welcome_page_body: Optional[str] = None
"""
The text for homepage startpage body
"""
# @ApiMember(Description="The text for homepage about us page heading")
about_us_page_heading: Optional[str] = None
"""
The text for homepage about us page heading
"""
# @ApiMember(Description="The text for homepage about us page body")
about_us_page_body: Optional[str] = None
"""
The text for homepage about us page body
"""
# @ApiMember(Description="The startpage image url")
image_url: Optional[str] = None
"""
The startpage image url
"""
# @ApiMember(Description="The cover image url")
cover_image: Optional[str] = None
"""
The cover image url
"""
# @ApiMember(Description="Show rating on the page")
show_rating: bool = False
"""
Show rating on the page
"""
# @ApiMember(Description="The template for the homepage")
home_page_template_id: int = 0
"""
The template for the homepage
"""
# @ApiMember(Description="The hero section style for the homepage")
hero_section_style_id: int = 0
"""
The hero section style for the homepage
"""
# @ApiMember(Description="Enable the BokaMera Homepage")
enable_homepage: bool = False
"""
Enable the BokaMera Homepage
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompanyRatingSummary:
# @ApiMember(Description="The average rating score")
average_score: float = 0.0
"""
The average rating score
"""
# @ApiMember(Description="The number of ratings of score 1")
rating_score1_count: int = 0
"""
The number of ratings of score 1
"""
# @ApiMember(Description="The number of ratings of score 2")
rating_score2_count: int = 0
"""
The number of ratings of score 2
"""
# @ApiMember(Description="The number of ratings of score 3")
rating_score3_count: int = 0
"""
The number of ratings of score 3
"""
# @ApiMember(Description="The number of ratings of score 4")
raing_score4_count: int = 0
"""
The number of ratings of score 4
"""
# @ApiMember(Description="The number of ratings of score 5")
rating_score5_count: int = 0
"""
The number of ratings of score 5
"""
# @ApiMember(Description="The number of ratings")
count: int = 0
"""
The number of ratings
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RatingReviewResponse:
# @ApiMember(Description="The title for the review")
title: Optional[str] = None
"""
The title for the review
"""
# @ApiMember(Description="The description for the review")
description: Optional[str] = None
"""
The description for the review
"""
# @ApiMember(Description="The rating score")
rating_score: int = 0
"""
The rating score
"""
# @ApiMember(Description="The review author")
author: Optional[str] = None
"""
The review author
"""
# @ApiMember(Description="The created date")
created: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The created date
"""
# @ApiMember(Description="The review answer from the company")
review_answer: Optional[str] = None
"""
The review answer from the company
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomFieldValueResponse:
value: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomFieldConfigData:
# @ApiMember(Description="Custom field id")
id: int = 0
"""
Custom field id
"""
# @ApiMember(Description="Configuration name. Example: 'Number of persons'.")
name: Optional[str] = None
"""
Configuration name. Example: 'Number of persons'.
"""
# @ApiMember(Description="Custom field description. Example: 'For how many persons is this booking?'")
description: Optional[str] = None
"""
Custom field description. Example: 'For how many persons is this booking?'
"""
# @ApiMember(Description="Field width. Example: 20 for 20px")
width: Optional[int] = None
"""
Field width. Example: 20 for 20px
"""
# @ApiMember(Description="Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox'")
data_type: Optional[str] = None
"""
Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox'
"""
# @ApiMember(Description="Default value of the field. Example: '3'")
default_value: Optional[str] = None
"""
Default value of the field. Example: '3'
"""
# @ApiMember(Description="Determines if the field is required to have a value or not")
is_mandatory: bool = False
"""
Determines if the field is required to have a value or not
"""
# @ApiMember(Description="Error message shown to the user if the field data is required but not entered")
mandatory_error_message: Optional[str] = None
"""
Error message shown to the user if the field data is required but not entered
"""
# @ApiMember(Description="Max lenght of the field")
max_length: int = 0
"""
Max lenght of the field
"""
# @ApiMember(Description="If the field should have multiple lines")
multiple_line_text: bool = False
"""
If the field should have multiple lines
"""
# @ApiMember(Description="Regular expression used for validation of the field")
reg_ex: Optional[str] = None
"""
Regular expression used for validation of the field
"""
# @ApiMember(Description="Error message shown if the regular expression validation failed")
reg_ex_error_message: Optional[str] = None
"""
Error message shown if the regular expression validation failed
"""
# @ApiMember(Description="The values to select from if Datatype is DropDown for this custom field")
values: List[CustomFieldValueResponse] = field(default_factory=list)
"""
The values to select from if Datatype is DropDown for this custom field
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompanyQueryResponse:
id: Optional[str] = None
name: Optional[str] = None
# @ApiMember(DataType="string", Description="The organisation number will only be visible if you are the owner of the company.")
organisation_number: Optional[str] = None
"""
The organisation number will only be visible if you are the owner of the company.
"""
# @ApiMember(DataType="int", Description="What type of company. If it's used for personal use or as a company.")
type_id: Optional[int] = None
"""
What type of company. If it's used for personal use or as a company.
"""
details: Optional[str] = None
category_id: int = 0
category: Optional[str] = None
logo_type: Optional[str] = None
cover_image: Optional[str] = None
street1: Optional[str] = None
street2: Optional[str] = None
zip_code: Optional[str] = None
city: Optional[str] = None
country_id: Optional[str] = None
longitude: Optional[str] = None
latitude: Optional[str] = None
distance: Optional[float] = None
phone: Optional[str] = None
email: Optional[str] = None
homepage: Optional[str] = None
site_path: Optional[str] = None
active: bool = False
code_lock_system: Optional[CodeLockSystemType] = None
is_free_account: bool = False
# @ApiMember(DataType="datetime", Description="Will show when the company was updated, note it will only be shown if your logged in as admin for the company.")
updated: Optional[datetime.datetime] = None
"""
Will show when the company was updated, note it will only be shown if your logged in as admin for the company.
"""
# @ApiMember(DataType="datetime", Description="Will show when the company was created, note it will only be shown if your logged in as admin for the company.")
created: Optional[datetime.datetime] = None
"""
Will show when the company was created, note it will only be shown if your logged in as admin for the company.
"""
status_id: int = 0
# @ApiMember(DataType="boolean", Description="If the company is marked as favourite for the logged in user")
is_favorite: bool = False
"""
If the company is marked as favourite for the logged in user
"""
booking_agreements: Optional[str] = None
booking_settings: Optional[CompanyBookingSettings] = None
system_settings: Optional[CompanySystemSettings] = None
widget_settings: Optional[CompanyWidgetSettings] = None
homepage_settings: Optional[HomepageSettingsResponse] = None
rating_summary: Optional[CompanyRatingSummary] = None
reviews: List[RatingReviewResponse] = field(default_factory=list)
customer_custom_fields: List[CustomFieldConfigData] = field(default_factory=list)
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserFavorites:
company_id: Optional[str] = None
company: Optional[CompanyQueryResponse] = None
# @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 AddFavorite:
# @ApiMember(Description="Id of the company", IsRequired=true, ParameterType="path")
company_id: Optional[str] = None
"""
Id of the company
"""
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /users/favorite HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AddFavorite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
</AddFavorite>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<UserFavorites xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Company>
<Active>false</Active>
<BookingAgreements>String</BookingAgreements>
<BookingSettings>
<BookOnlyOnExistingCustomers>false</BookOnlyOnExistingCustomers>
<BookingAgreement>String</BookingAgreement>
<BookingPinCodeRestriction>String</BookingPinCodeRestriction>
<BookingReceiptMessage>String</BookingReceiptMessage>
<CustomerInvoiceAdressRequired>false</CustomerInvoiceAdressRequired>
<EnableMobileApp>false</EnableMobileApp>
<EnableShowBookedTimes>false</EnableShowBookedTimes>
<PaymentEnabled>false</PaymentEnabled>
<PaymentProviderId>0</PaymentProviderId>
<ShowBookedTimes>false</ShowBookedTimes>
<ShowFreeTimesLeft>false</ShowFreeTimesLeft>
<WeekNumberSetting>0</WeekNumberSetting>
</BookingSettings>
<Category>String</Category>
<CategoryId>0</CategoryId>
<City>String</City>
<CodeLockSystem>Sample</CodeLockSystem>
<CountryId>String</CountryId>
<CoverImage i:nil="true" />
<Created>0001-01-01T00:00:00</Created>
<CustomerCustomFields>
<CustomFieldConfigData>
<DataType>String</DataType>
<DefaultValue>String</DefaultValue>
<Description>String</Description>
<Id>0</Id>
<IsMandatory>false</IsMandatory>
<MandatoryErrorMessage>String</MandatoryErrorMessage>
<MaxLength>0</MaxLength>
<MultipleLineText>false</MultipleLineText>
<Name>String</Name>
<RegEx>String</RegEx>
<RegExErrorMessage>String</RegExErrorMessage>
<Values>
<CustomFieldValueResponse>
<Value>String</Value>
</CustomFieldValueResponse>
</Values>
<Width>0</Width>
</CustomFieldConfigData>
</CustomerCustomFields>
<Details>String</Details>
<Distance>0</Distance>
<Email>String</Email>
<Homepage>String</Homepage>
<HomepageSettings>
<AboutUsPageBody>String</AboutUsPageBody>
<AboutUsPageHeading>String</AboutUsPageHeading>
<CoverImage i:nil="true" />
<EnableHomepage>false</EnableHomepage>
<HeroSectionStyleId>0</HeroSectionStyleId>
<HomePageTemplateId>0</HomePageTemplateId>
<HomepageHeading>String</HomepageHeading>
<ImageUrl i:nil="true" />
<ShowRating>false</ShowRating>
<WelcomePageBody>String</WelcomePageBody>
<WelcomePageHeading>String</WelcomePageHeading>
</HomepageSettings>
<Id>00000000-0000-0000-0000-000000000000</Id>
<IsFavorite>false</IsFavorite>
<IsFreeAccount>false</IsFreeAccount>
<Latitude>String</Latitude>
<LogoType i:nil="true" />
<Longitude>String</Longitude>
<Name>String</Name>
<OrganisationNumber>String</OrganisationNumber>
<Phone>String</Phone>
<RatingSummary>
<AverageScore>0</AverageScore>
<Count>0</Count>
<RaingScore4Count>0</RaingScore4Count>
<RatingScore1Count>0</RatingScore1Count>
<RatingScore2Count>0</RatingScore2Count>
<RatingScore3Count>0</RatingScore3Count>
<RatingScore5Count>0</RatingScore5Count>
</RatingSummary>
<ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
<d3p1:ErrorCode>String</d3p1:ErrorCode>
<d3p1:Message>String</d3p1:Message>
<d3p1:StackTrace>String</d3p1:StackTrace>
<d3p1:Errors>
<d3p1:ResponseError>
<d3p1:ErrorCode>String</d3p1:ErrorCode>
<d3p1:FieldName>String</d3p1:FieldName>
<d3p1:Message>String</d3p1:Message>
<d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</d3p1:Meta>
</d3p1:ResponseError>
</d3p1:Errors>
<d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</d3p1:Meta>
</ResponseStatus>
<Reviews>
<RatingReviewResponse>
<Author>String</Author>
<Created>0001-01-01T00:00:00</Created>
<Description>String</Description>
<RatingScore>0</RatingScore>
<ReviewAnswer>String</ReviewAnswer>
<Title>String</Title>
</RatingReviewResponse>
</Reviews>
<SitePath>String</SitePath>
<StatusId>0</StatusId>
<Street1>String</Street1>
<Street2>String</Street2>
<SystemSettings>
<Active>false</Active>
<DefaultLanguage>String</DefaultLanguage>
<EmailMessageDailySendLimit>0</EmailMessageDailySendLimit>
<EnableAPITranslation>false</EnableAPITranslation>
<FacebookPixelId>String</FacebookPixelId>
<GATrackingId>String</GATrackingId>
<GTMTrackingId>String</GTMTrackingId>
<GoogleAdsConversionId>String</GoogleAdsConversionId>
<GoogleAdsConversionLabel>String</GoogleAdsConversionLabel>
<InactiveMessage>String</InactiveMessage>
<LinkedinTagId>String</LinkedinTagId>
<MultiLanguage>false</MultiLanguage>
<SMSMessageDailySendLimit>0</SMSMessageDailySendLimit>
<Searchable>false</Searchable>
<SendCustomerInformationToExternalProviders>false</SendCustomerInformationToExternalProviders>
<ShowOnMarketplace>false</ShowOnMarketplace>
</SystemSettings>
<TypeId>0</TypeId>
<Updated>0001-01-01T00:00:00</Updated>
<WidgetSettings>
<BookedTimeSlotText>String</BookedTimeSlotText>
<BookingLayoutId>0</BookingLayoutId>
<DarkTheme>false</DarkTheme>
<PrimaryColor>String</PrimaryColor>
<ServiceLayoutId>0</ServiceLayoutId>
<ShowEndTime>false</ShowEndTime>
<ShowNextAvailableTime>false</ShowNextAvailableTime>
<ShowRebateCodeField>false</ShowRebateCodeField>
<ShowServiceImage>false</ShowServiceImage>
<ShowSubscribeToNewsletter>false</ShowSubscribeToNewsletter>
<TimeLayoutId>0</TimeLayoutId>
</WidgetSettings>
<ZipCode>String</ZipCode>
</Company>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
</UserFavorites>