| 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.*
@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")
open class UpdateSystemSetting : 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.")
var CompanyId:UUID? = null
/**
* If the booking is active or not
*/
@ApiMember(DataType="bool", Description="If the booking is active or not")
var Active:Boolean? = 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")
var InactiveMessage:String? = 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")
var Searchable:Boolean? = 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.")
var GATrackingId:String? = 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.")
var GoogleAdsConversionId:String? = 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.")
var LinkedinTagId:String? = 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.")
var GoogleAdsConversionLabel:String? = 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.")
var GTMTrackingId:String? = 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.")
var FacebookPixelId:String? = null
/**
* If the company should be visible on the marketplace
*/
@ApiMember(DataType="bool", Description="If the company should be visible on the marketplace")
var ShowOnMarketplace:Boolean? = 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")
var MultiLanguage:Boolean? = 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")
var EnableAPITranslation:Boolean? = 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")
var DefaultLanguage:String? = 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. ")
var SendCustomerInformationToExternalProviders:Boolean? = 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.")
var SMSMessageDailySendLimit:Int? = 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.")
var EmailMessageDailySendLimit:Int? = null
}
open class SystemSettingsResponse
{
/**
* The country options to choose from
*/
@ApiMember(Description="The country options to choose from")
var LanguageOptions:ArrayList<LanguageResponse> = ArrayList<LanguageResponse>()
/**
* If the booking is active or not
*/
@ApiMember(DataType="bool", Description="If the booking is active or not")
var Active:Boolean? = 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")
var InactiveMessage:String? = 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")
var Searchable:Boolean? = 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.")
var GATrackingId:String? = 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.")
var GoogleAdsConversionId:String? = 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.")
var LinkedinTagId:String? = 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.")
var GoogleAdsConversionLabel:String? = 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.")
var GTMTrackingId:String? = 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.")
var FacebookPixelId:String? = null
/**
* If the company should be visible on the marketplace
*/
@ApiMember(DataType="bool", Description="If the company should be visible on the marketplace")
var ShowOnMarketplace:Boolean? = 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")
var MultiLanguage:Boolean? = 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")
var EnableAPITranslation:Boolean? = 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")
var DefaultLanguage:String? = 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. ")
var SendCustomerInformationToExternalProviders:Boolean? = null
}
open class LanguageResponse
{
var Id:String? = null
var Name:String? = null
}
Kotlin 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: testapi.bokamera.se
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
}