| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /settings/system | Update system settings for the currently logged in user | Update system settings for the currently logged in user. |
|---|
"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 UpdateSystemSetting {
/** @param {{CompanyId?:string,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,SMSMessageDailySendLimit?:number,EmailMessageDailySendLimit?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description The company id, if empty will use the company id for the user you are logged in with. */
CompanyId;
/**
* @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;
/**
* @type {?number}
* @description The maximum number of SMS messages that can be sent per day. */
SMSMessageDailySendLimit;
/**
* @type {?number}
* @description The maximum number of email messages that can be sent per day. */
EmailMessageDailySendLimit;
}
JavaScript UpdateSystemSetting DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /settings/system HTTP/1.1
Host: api.bookmore.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
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,
SMSMessageDailySendLimit: 0,
EmailMessageDailySendLimit: 0
}
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,
SendCustomerInformationToExternalProviders: False
}