BokaMera.API.Host

<back to all web services

SystemSettingQuery

The following routes are available for this service:
GET/settings/systemGet system settings for the currently logged in userGet system settings for the currently logged in user.
import java.math.*
import java.util.*
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
open class SystemSettingQuery
{
    /**
    * If you want to include the language options to select from
    */
    @ApiMember(DataType="boolean", Description="If you want to include the language options to select from", ParameterType="query")
    var IncludeLanguageOptions:Boolean? = null
}

open class SystemSettingsResponse
{
    /**
    * The country options to choose from
    */
    @ApiMember(Description="The country options to choose from")
    var LanguageOptions:ArrayList<LanguageResponse> = ArrayList<LanguageResponse>()

    /**
    * If the booking is active or not
    */
    @ApiMember(DataType="bool", Description="If the booking is active or not")
    var Active:Boolean? = null

    /**
    * If the booking is not active, what message to show to the customers
    */
    @ApiMember(DataType="string", Description="If the booking is not active, what message to show to the customers")
    var InactiveMessage:String? = null

    /**
    * If the company should be visible in search results on hompage
    */
    @ApiMember(DataType="bool", Description="If the company should be visible in search results on hompage")
    var Searchable:Boolean? = null

    /**
    * If you have a google analytics account and want to track your customers behaviors.
    */
    @ApiMember(DataType="string", Description="If you have a google analytics account and want to track your customers behaviors.")
    var GATrackingId:String? = null

    /**
    * If you have a google Ads Conversion Id 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.")
    var GoogleAdsConversionId:String? = null

    /**
    * If you have a LinkedIn 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.")
    var LinkedinTagId:String? = null

    /**
    * If you have a Google Ads Conversion Label 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.")
    var GoogleAdsConversionLabel:String? = null

    /**
    * If you have a google tag manager account 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.")
    var GTMTrackingId:String? = null

    /**
    * If you have a facebook 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.")
    var FacebookPixelId:String? = null

    /**
    * If the company should be visible on the marketplace
    */
    @ApiMember(DataType="bool", Description="If the company should be visible on the marketplace")
    var ShowOnMarketplace:Boolean? = null

    /**
    * If you want your customers to be albe to change language on your homepage
    */
    @ApiMember(DataType="bool", Description="If you want your customers to be albe to change language on your homepage")
    var MultiLanguage:Boolean? = null

    /**
    * If you want your own written text on your homepage to be translated using google analytics when a user changes language
    */
    @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")
    var EnableAPITranslation:Boolean? = null

    /**
    * What is the standard language your homepage information is written in. Select from the different countries, ie. SE,NO,EN
    */
    @ApiMember(DataType="string", Description="What is the standard language your homepage information is written in. Select from the different countries, ie. SE,NO,EN")
    var DefaultLanguage:String? = null

    /**
    * 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="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. ")
    var SendCustomerInformationToExternalProviders:Boolean? = null
}

open class LanguageResponse
{
    var Id:String? = null
    var Name:String? = null
}

Kotlin SystemSettingQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /settings/system HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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","SendCustomerInformationToExternalProviders":false}