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.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class LanguageResponse
    {
        public virtual string Id { get; set; }
        public virtual string Name { get; set; }
    }

    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    [ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)]
    public partial class SystemSettingQuery
    {
        ///<summary>
        ///If you want to include the language options to select from
        ///</summary>
        [ApiMember(DataType="boolean", Description="If you want to include the language options to select from", ParameterType="query")]
        public virtual bool IncludeLanguageOptions { get; set; }
    }

    public partial class SystemSettingsResponse
    {
        public SystemSettingsResponse()
        {
            LanguageOptions = new List<LanguageResponse>{};
        }

        ///<summary>
        ///The country options to choose from
        ///</summary>
        [ApiMember(Description="The country options to choose from")]
        public virtual List<LanguageResponse> LanguageOptions { get; set; }

        ///<summary>
        ///If the booking is active or not
        ///</summary>
        [ApiMember(DataType="bool", Description="If the booking is active or not")]
        public virtual bool Active { get; set; }

        ///<summary>
        ///If the booking is not active, what message to show to the customers
        ///</summary>
        [ApiMember(DataType="string", Description="If the booking is not active, what message to show to the customers")]
        public virtual string InactiveMessage { get; set; }

        ///<summary>
        ///If the company should be visible in search results on hompage
        ///</summary>
        [ApiMember(DataType="bool", Description="If the company should be visible in search results on hompage")]
        public virtual bool Searchable { get; set; }

        ///<summary>
        ///If you have a google analytics account and want to track your customers behaviors.
        ///</summary>
        [ApiMember(DataType="string", Description="If you have a google analytics account and want to track your customers behaviors.")]
        public virtual string GATrackingId { get; set; }

        ///<summary>
        ///If you have a google Ads Conversion Id account and want to track your customers behaviors.
        ///</summary>
        [ApiMember(DataType="string", Description="If you have a google Ads Conversion Id account and want to track your customers behaviors.")]
        public virtual string GoogleAdsConversionId { get; set; }

        ///<summary>
        ///If you have a LinkedIn account and want to track your customers behaviors.
        ///</summary>
        [ApiMember(DataType="string", Description="If you have a LinkedIn account and want to track your customers behaviors.")]
        public virtual string LinkedinTagId { get; set; }

        ///<summary>
        ///If you have a Google Ads Conversion Label and want to track your customers behaviors.
        ///</summary>
        [ApiMember(DataType="string", Description="If you have a Google Ads Conversion Label and want to track your customers behaviors.")]
        public virtual string GoogleAdsConversionLabel { get; set; }

        ///<summary>
        ///If you have a google tag manager account and want to track your customers behaviors.
        ///</summary>
        [ApiMember(DataType="string", Description="If you have a google tag manager account and want to track your customers behaviors.")]
        public virtual string GTMTrackingId { get; set; }

        ///<summary>
        ///If you have a facebook account and want to track your customers behaviors.
        ///</summary>
        [ApiMember(DataType="string", Description="If you have a facebook account and want to track your customers behaviors.")]
        public virtual string FacebookPixelId { get; set; }

        ///<summary>
        ///If the company should be visible on the marketplace
        ///</summary>
        [ApiMember(DataType="bool", Description="If the company should be visible on the marketplace")]
        public virtual bool ShowOnMarketplace { get; set; }

        ///<summary>
        ///If you want your customers to be albe to change language on your homepage
        ///</summary>
        [ApiMember(DataType="bool", Description="If you want your customers to be albe to change language on your homepage")]
        public virtual bool MultiLanguage { get; set; }

        ///<summary>
        ///If you want your own written text on your homepage to be translated using google analytics when a user changes language
        ///</summary>
        [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")]
        public virtual bool EnableAPITranslation { get; set; }

        ///<summary>
        ///What is the standard language your homepage information is written in. Select from the different countries, ie. SE,NO,EN
        ///</summary>
        [ApiMember(DataType="string", Description="What is the standard language your homepage information is written in. Select from the different countries, ie. SE,NO,EN")]
        public virtual string DefaultLanguage { get; set; }

        ///<summary>
        ///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. 
        ///</summary>
        [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. ")]
        public virtual bool SendCustomerInformationToExternalProviders { get; set; }
    }

}

C# SystemSettingQuery DTOs

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

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SystemSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <DefaultLanguage>String</DefaultLanguage>
  <EnableAPITranslation>false</EnableAPITranslation>
  <FacebookPixelId>String</FacebookPixelId>
  <GATrackingId>String</GATrackingId>
  <GTMTrackingId>String</GTMTrackingId>
  <GoogleAdsConversionId>String</GoogleAdsConversionId>
  <GoogleAdsConversionLabel>String</GoogleAdsConversionLabel>
  <InactiveMessage>String</InactiveMessage>
  <LanguageOptions>
    <LanguageResponse>
      <Id>String</Id>
      <Name>String</Name>
    </LanguageResponse>
  </LanguageOptions>
  <LinkedinTagId>String</LinkedinTagId>
  <MultiLanguage>false</MultiLanguage>
  <Searchable>false</Searchable>
  <SendCustomerInformationToExternalProviders>false</SendCustomerInformationToExternalProviders>
  <ShowOnMarketplace>false</ShowOnMarketplace>
</SystemSettingsResponse>