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. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | body | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
Active | body | bool | No | If the booking is active or not |
InactiveMessage | body | string | No | If the booking is not active, what message to show to the customers |
Searchable | body | bool | No | If the company should be visible in search results on hompage |
GATrackingId | body | string | No | If you have a google analytics account and want to track your customers behaviors. |
GoogleAdsConversionId | body | string | No | If you have a google Ads Conversion Id account and want to track your customers behaviors. |
LinkedinTagId | body | string | No | If you have a LinkedIn account and want to track your customers behaviors. |
GoogleAdsConversionLabel | body | string | No | If you have a Google Ads Conversion Label and want to track your customers behaviors. |
GTMTrackingId | body | string | No | If you have a google tag manager account and want to track your customers behaviors. |
FacebookPixelId | body | string | No | If you have a facebook account and want to track your customers behaviors. |
ShowOnMarketplace | body | bool | No | If the company should be visible on the marketplace |
MultiLanguage | body | bool | No | If you want your customers to be albe to change language on your homepage |
EnableAPITranslation | body | bool | No | If you want your own written text on your homepage to be translated using google analytics when a user changes language |
DefaultLanguage | body | string | No | What is the standard language your homepage information is written in. Select from the different countries, ie. SE,NO,EN |
SendCustomerInformationToExternalProviders | body | bool? | No | 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. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LanguageOptions | form | List<LanguageResponse> | No | The country options to choose from |
Active | form | bool | No | If the booking is active or not |
InactiveMessage | form | string | No | If the booking is not active, what message to show to the customers |
Searchable | form | bool | No | If the company should be visible in search results on hompage |
GATrackingId | form | string | No | If you have a google analytics account and want to track your customers behaviors. |
GoogleAdsConversionId | form | string | No | If you have a google Ads Conversion Id account and want to track your customers behaviors. |
LinkedinTagId | form | string | No | If you have a LinkedIn account and want to track your customers behaviors. |
GoogleAdsConversionLabel | form | string | No | If you have a Google Ads Conversion Label and want to track your customers behaviors. |
GTMTrackingId | form | string | No | If you have a google tag manager account and want to track your customers behaviors. |
FacebookPixelId | form | string | No | If you have a facebook account and want to track your customers behaviors. |
ShowOnMarketplace | form | bool | No | If the company should be visible on the marketplace |
MultiLanguage | form | bool | No | If you want your customers to be albe to change language on your homepage |
EnableAPITranslation | form | bool | No | If you want your own written text on your homepage to be translated using google analytics when a user changes language |
DefaultLanguage | form | string | No | What is the standard language your homepage information is written in. Select from the different countries, ie. SE,NO,EN |
SendCustomerInformationToExternalProviders | form | bool | No | 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. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateSystemSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Active>false</Active>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<DefaultLanguage>String</DefaultLanguage>
<EnableAPITranslation>false</EnableAPITranslation>
<FacebookPixelId>String</FacebookPixelId>
<GATrackingId>String</GATrackingId>
<GTMTrackingId>String</GTMTrackingId>
<GoogleAdsConversionId>String</GoogleAdsConversionId>
<GoogleAdsConversionLabel>String</GoogleAdsConversionLabel>
<InactiveMessage>String</InactiveMessage>
<LinkedinTagId>String</LinkedinTagId>
<MultiLanguage>false</MultiLanguage>
<Searchable>false</Searchable>
<SendCustomerInformationToExternalProviders>false</SendCustomerInformationToExternalProviders>
<ShowOnMarketplace>false</ShowOnMarketplace>
</UpdateSystemSetting>
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>