BokaMera.API.Host

<back to all web services

SystemSettingQuery

"use strict";
export class LanguageResponse {
    /** @param {{Id?:string,Name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Name;
}
export class SystemSettingsResponse {
    /** @param {{LanguageOptions?:LanguageResponse[],Active?:boolean,InactiveMessage?:string,Searchable?:boolean,GATrackingId?:string,GoogleAdsConversionId?:string,LinkedinTagId?:string,GoogleAdsConversionLabel?:string,GTMTrackingId?:string,FacebookPixelId?:string,ShowOnMarketplace?:boolean,MultiLanguage?:boolean,EnableAPITranslation?:boolean,DefaultLanguage?:string,SendCustomerInformationToExternalProviders?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {LanguageResponse[]}
     * @description The country options to choose from */
    LanguageOptions;
    /**
     * @type {boolean}
     * @description If the booking is active or not */
    Active;
    /**
     * @type {string}
     * @description If the booking is not active, what message to show to the customers */
    InactiveMessage;
    /**
     * @type {boolean}
     * @description If the company should be visible in search results on hompage */
    Searchable;
    /**
     * @type {string}
     * @description If you have a google analytics account and want to track your customers behaviors. */
    GATrackingId;
    /**
     * @type {string}
     * @description If you have a google Ads Conversion Id account and want to track your customers behaviors. */
    GoogleAdsConversionId;
    /**
     * @type {string}
     * @description If you have a LinkedIn account and want to track your customers behaviors. */
    LinkedinTagId;
    /**
     * @type {string}
     * @description If you have a Google Ads Conversion Label and want to track your customers behaviors. */
    GoogleAdsConversionLabel;
    /**
     * @type {string}
     * @description If you have a google tag manager account and want to track your customers behaviors. */
    GTMTrackingId;
    /**
     * @type {string}
     * @description If you have a facebook account and want to track your customers behaviors. */
    FacebookPixelId;
    /**
     * @type {boolean}
     * @description If the company should be visible on the marketplace */
    ShowOnMarketplace;
    /**
     * @type {boolean}
     * @description If you want your customers to be albe to change language on your homepage */
    MultiLanguage;
    /**
     * @type {boolean}
     * @description If you want your own written text on your homepage to be translated using google analytics when a user changes language */
    EnableAPITranslation;
    /**
     * @type {string}
     * @description What is the standard language your homepage information is written in. Select from the different countries, ie. SE,NO,EN */
    DefaultLanguage;
    /**
     * @type {boolean}
     * @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.  */
    SendCustomerInformationToExternalProviders;
}
export class SystemSettingQuery {
    /** @param {{IncludeLanguageOptions?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {boolean}
     * @description If you want to include the language options to select from */
    IncludeLanguageOptions;
}

JavaScript SystemSettingQuery DTOs

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>