| 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. |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
@ValidateRequest(Validator="IsAuthenticated")
public static class UpdateSystemSetting implements ICompany
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
@ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
public UUID CompanyId = null;
/**
* If the booking is active or not
*/
@ApiMember(DataType="bool", Description="If the booking is active or not")
public Boolean Active = 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")
public String InactiveMessage = 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")
public Boolean Searchable = 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.")
public String GATrackingId = 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.")
public String GoogleAdsConversionId = 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.")
public String LinkedinTagId = 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.")
public String GoogleAdsConversionLabel = 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.")
public String GTMTrackingId = 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.")
public String FacebookPixelId = null;
/**
* If the company should be visible on the marketplace
*/
@ApiMember(DataType="bool", Description="If the company should be visible on the marketplace")
public Boolean ShowOnMarketplace = 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")
public Boolean MultiLanguage = 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")
public Boolean EnableAPITranslation = 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")
public String DefaultLanguage = 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. ")
public Boolean SendCustomerInformationToExternalProviders = null;
/**
* The maximum number of SMS messages that can be sent per day.
*/
@ApiMember(Description="The maximum number of SMS messages that can be sent per day.")
public Integer SMSMessageDailySendLimit = null;
/**
* The maximum number of email messages that can be sent per day.
*/
@ApiMember(Description="The maximum number of email messages that can be sent per day.")
public Integer EmailMessageDailySendLimit = null;
public UUID getCompanyId() { return CompanyId; }
public UpdateSystemSetting setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Boolean isActive() { return Active; }
public UpdateSystemSetting setActive(Boolean value) { this.Active = value; return this; }
public String getInactiveMessage() { return InactiveMessage; }
public UpdateSystemSetting setInactiveMessage(String value) { this.InactiveMessage = value; return this; }
public Boolean isSearchable() { return Searchable; }
public UpdateSystemSetting setSearchable(Boolean value) { this.Searchable = value; return this; }
public String getGaTrackingId() { return GATrackingId; }
public UpdateSystemSetting setGaTrackingId(String value) { this.GATrackingId = value; return this; }
public String getGoogleAdsConversionId() { return GoogleAdsConversionId; }
public UpdateSystemSetting setGoogleAdsConversionId(String value) { this.GoogleAdsConversionId = value; return this; }
public String getLinkedinTagId() { return LinkedinTagId; }
public UpdateSystemSetting setLinkedinTagId(String value) { this.LinkedinTagId = value; return this; }
public String getGoogleAdsConversionLabel() { return GoogleAdsConversionLabel; }
public UpdateSystemSetting setGoogleAdsConversionLabel(String value) { this.GoogleAdsConversionLabel = value; return this; }
public String getGtmTrackingId() { return GTMTrackingId; }
public UpdateSystemSetting setGtmTrackingId(String value) { this.GTMTrackingId = value; return this; }
public String getFacebookPixelId() { return FacebookPixelId; }
public UpdateSystemSetting setFacebookPixelId(String value) { this.FacebookPixelId = value; return this; }
public Boolean isShowOnMarketplace() { return ShowOnMarketplace; }
public UpdateSystemSetting setShowOnMarketplace(Boolean value) { this.ShowOnMarketplace = value; return this; }
public Boolean isMultiLanguage() { return MultiLanguage; }
public UpdateSystemSetting setMultiLanguage(Boolean value) { this.MultiLanguage = value; return this; }
public Boolean isEnableAPITranslation() { return EnableAPITranslation; }
public UpdateSystemSetting setEnableAPITranslation(Boolean value) { this.EnableAPITranslation = value; return this; }
public String getDefaultLanguage() { return DefaultLanguage; }
public UpdateSystemSetting setDefaultLanguage(String value) { this.DefaultLanguage = value; return this; }
public Boolean isSendCustomerInformationToExternalProviders() { return SendCustomerInformationToExternalProviders; }
public UpdateSystemSetting setSendCustomerInformationToExternalProviders(Boolean value) { this.SendCustomerInformationToExternalProviders = value; return this; }
public Integer getSmsMessageDailySendLimit() { return SMSMessageDailySendLimit; }
public UpdateSystemSetting setSmsMessageDailySendLimit(Integer value) { this.SMSMessageDailySendLimit = value; return this; }
public Integer getEmailMessageDailySendLimit() { return EmailMessageDailySendLimit; }
public UpdateSystemSetting setEmailMessageDailySendLimit(Integer value) { this.EmailMessageDailySendLimit = value; return this; }
}
public static class SystemSettingsResponse
{
/**
* The country options to choose from
*/
@ApiMember(Description="The country options to choose from")
public ArrayList<LanguageResponse> LanguageOptions = null;
/**
* If the booking is active or not
*/
@ApiMember(DataType="bool", Description="If the booking is active or not")
public Boolean Active = 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")
public String InactiveMessage = 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")
public Boolean Searchable = 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.")
public String GATrackingId = 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.")
public String GoogleAdsConversionId = 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.")
public String LinkedinTagId = 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.")
public String GoogleAdsConversionLabel = 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.")
public String GTMTrackingId = 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.")
public String FacebookPixelId = null;
/**
* If the company should be visible on the marketplace
*/
@ApiMember(DataType="bool", Description="If the company should be visible on the marketplace")
public Boolean ShowOnMarketplace = 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")
public Boolean MultiLanguage = 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")
public Boolean EnableAPITranslation = 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")
public String DefaultLanguage = 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. ")
public Boolean SendCustomerInformationToExternalProviders = null;
public ArrayList<LanguageResponse> getLanguageOptions() { return LanguageOptions; }
public SystemSettingsResponse setLanguageOptions(ArrayList<LanguageResponse> value) { this.LanguageOptions = value; return this; }
public Boolean isActive() { return Active; }
public SystemSettingsResponse setActive(Boolean value) { this.Active = value; return this; }
public String getInactiveMessage() { return InactiveMessage; }
public SystemSettingsResponse setInactiveMessage(String value) { this.InactiveMessage = value; return this; }
public Boolean isSearchable() { return Searchable; }
public SystemSettingsResponse setSearchable(Boolean value) { this.Searchable = value; return this; }
public String getGaTrackingId() { return GATrackingId; }
public SystemSettingsResponse setGaTrackingId(String value) { this.GATrackingId = value; return this; }
public String getGoogleAdsConversionId() { return GoogleAdsConversionId; }
public SystemSettingsResponse setGoogleAdsConversionId(String value) { this.GoogleAdsConversionId = value; return this; }
public String getLinkedinTagId() { return LinkedinTagId; }
public SystemSettingsResponse setLinkedinTagId(String value) { this.LinkedinTagId = value; return this; }
public String getGoogleAdsConversionLabel() { return GoogleAdsConversionLabel; }
public SystemSettingsResponse setGoogleAdsConversionLabel(String value) { this.GoogleAdsConversionLabel = value; return this; }
public String getGtmTrackingId() { return GTMTrackingId; }
public SystemSettingsResponse setGtmTrackingId(String value) { this.GTMTrackingId = value; return this; }
public String getFacebookPixelId() { return FacebookPixelId; }
public SystemSettingsResponse setFacebookPixelId(String value) { this.FacebookPixelId = value; return this; }
public Boolean isShowOnMarketplace() { return ShowOnMarketplace; }
public SystemSettingsResponse setShowOnMarketplace(Boolean value) { this.ShowOnMarketplace = value; return this; }
public Boolean isMultiLanguage() { return MultiLanguage; }
public SystemSettingsResponse setMultiLanguage(Boolean value) { this.MultiLanguage = value; return this; }
public Boolean isEnableAPITranslation() { return EnableAPITranslation; }
public SystemSettingsResponse setEnableAPITranslation(Boolean value) { this.EnableAPITranslation = value; return this; }
public String getDefaultLanguage() { return DefaultLanguage; }
public SystemSettingsResponse setDefaultLanguage(String value) { this.DefaultLanguage = value; return this; }
public Boolean isSendCustomerInformationToExternalProviders() { return SendCustomerInformationToExternalProviders; }
public SystemSettingsResponse setSendCustomerInformationToExternalProviders(Boolean value) { this.SendCustomerInformationToExternalProviders = value; return this; }
}
public static class LanguageResponse
{
public String Id = null;
public String Name = null;
public String getId() { return Id; }
public LanguageResponse setId(String value) { this.Id = value; return this; }
public String getName() { return Name; }
public LanguageResponse setName(String value) { this.Name = value; return this; }
}
}
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>
<EmailMessageDailySendLimit>0</EmailMessageDailySendLimit>
<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>
<SMSMessageDailySendLimit>0</SMSMessageDailySendLimit>
<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>