BokaMera.API.Host

<back to all web services

SystemSettingQuery

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 LanguageResponse:
    id: Optional[str] = None
    name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SystemSettingsResponse:
    # @ApiMember(Description="The country options to choose from")
    language_options: Optional[List[LanguageResponse]] = None
    """
    The country options to choose from
    """


    # @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 hompage")
    searchable: bool = False
    """
    If the company should be visible in search results on hompage
    """


    # @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 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 customers to be albe to change language on your homepage")
    multi_language: bool = False
    """
    If you want your customers to be albe to change language on your homepage
    """


    # @ApiMember(DataType="bool", Description="If you want your own written text on your homepage to be translated using google analytics 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 analytics 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, ie. SE,NO,EN")
    default_language: Optional[str] = None
    """
    What is the standard language your homepage information is written in. Select from the different countries, ie. SE,NO,EN
    """


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SystemSettingQuery:
    # @ApiMember(DataType="boolean", Description="If you want to include the language options to select from", ParameterType="query")
    include_language_options: bool = False
    """
    If you want to include the language options to select from
    """

Python SystemSettingQuery DTOs

GET /settings/system HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv

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

{
	LanguageOptions: 
	[
		{
			Id: String,
			Name: String
		}
	],
	Active: False,
	InactiveMessage: String,
	Searchable: False,
	GATrackingId: String,
	GoogleAdsConversionId: String,
	LinkedinTagId: String,
	GoogleAdsConversionLabel: String,
	GTMTrackingId: String,
	FacebookPixelId: String,
	ShowOnMarketplace: False,
	MultiLanguage: False,
	EnableAPITranslation: False,
	DefaultLanguage: String
}