| 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 Foundation
import ServiceStack
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privileges to call this service", StatusCode=403)
// @ValidateRequest(Validator="IsAuthenticated")
public class UpdateSystemSetting : ICompany, Codable
{
/**
* 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 var companyId:String?
/**
* If the booking is active or not
*/
// @ApiMember(DataType="bool", Description="If the booking is active or not")
public var active:Bool?
/**
* 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 var inactiveMessage:String
/**
* If the company should be visible in search results on homepage
*/
// @ApiMember(DataType="bool", Description="If the company should be visible in search results on homepage")
public var searchable:Bool?
/**
* 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 var gaTrackingId:String
/**
* 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 var googleAdsConversionId:String
/**
* 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 var linkedinTagId:String
/**
* 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 var googleAdsConversionLabel:String
/**
* 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 var gtmTrackingId:String
/**
* 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 var facebookPixelId:String
/**
* If the company should be visible on the marketplace
*/
// @ApiMember(DataType="bool", Description="If the company should be visible on the marketplace")
public var showOnMarketplace:Bool?
/**
* If you want your customers to be able to change language on your homepage
*/
// @ApiMember(DataType="bool", Description="If you want your customers to be able to change language on your homepage")
public var multiLanguage:Bool?
/**
* If you want your own written text on your homepage to be translated using Google Translate when a user changes language
*/
// @ApiMember(DataType="bool", Description="If you want your own written text on your homepage to be translated using Google Translate when a user changes language")
public var enableAPITranslation:Bool?
/**
* What is the standard language your homepage information is written in. Select from the different countries, i.e. SE,NO,EN
*/
// @ApiMember(DataType="string", Description="What is the standard language your homepage information is written in. Select from the different countries, i.e. SE,NO,EN")
public var defaultLanguage:String
/**
* 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 var sendCustomerInformationToExternalProviders:Bool?
/**
* 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 var smsMessageDailySendLimit:Int?
/**
* 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 var emailMessageDailySendLimit:Int?
required public init(){}
}
public class SystemSettingsResponse : Codable
{
/**
* The country options to choose from
*/
// @ApiMember(Description="The country options to choose from")
public var languageOptions:[LanguageResponse] = []
/**
* If the booking is active or not
*/
// @ApiMember(DataType="bool", Description="If the booking is active or not")
public var active:Bool
/**
* 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 var inactiveMessage:String
/**
* If the company should be visible in search results on homepage
*/
// @ApiMember(DataType="bool", Description="If the company should be visible in search results on homepage")
public var searchable:Bool
/**
* 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 var gaTrackingId:String
/**
* 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 var googleAdsConversionId:String
/**
* 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 var linkedinTagId:String
/**
* 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 var googleAdsConversionLabel:String
/**
* 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 var gtmTrackingId:String
/**
* 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 var facebookPixelId:String
/**
* If the company should be visible on the marketplace
*/
// @ApiMember(DataType="bool", Description="If the company should be visible on the marketplace")
public var showOnMarketplace:Bool
/**
* If you want your customers to be able to change language on your homepage
*/
// @ApiMember(DataType="bool", Description="If you want your customers to be able to change language on your homepage")
public var multiLanguage:Bool
/**
* If you want your own written text on your homepage to be translated using Google Translate when a user changes language
*/
// @ApiMember(DataType="bool", Description="If you want your own written text on your homepage to be translated using Google Translate when a user changes language")
public var enableAPITranslation:Bool
/**
* What is the standard language your homepage information is written in. Select from the different countries, i.e. SE,NO,EN
*/
// @ApiMember(DataType="string", Description="What is the standard language your homepage information is written in. Select from the different countries, i.e. SE,NO,EN")
public var defaultLanguage:String
/**
* 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 var sendCustomerInformationToExternalProviders:Bool
required public init(){}
}
public class LanguageResponse : Codable
{
public var id:String
public var name:String
required public init(){}
}
Swift 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.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
}