| GET | /settings/system | Get system settings for the currently logged in user | Get system settings for the currently logged in user. |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Namespace Global
Namespace BokaMera.API.ServiceModel.Dtos
Public Partial Class LanguageResponse
Public Overridable Property Id As String
Public Overridable Property Name As String
End Class
<ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
<ApiResponse(Description:="You have too low privilegies to call this service", StatusCode:=403)>
Public Partial Class SystemSettingQuery
'''<Summary>
'''If you want to include the language options to select from
'''</Summary>
<ApiMember(DataType:="boolean", Description:="If you want to include the language options to select from", ParameterType:="query")>
Public Overridable Property IncludeLanguageOptions As Boolean
End Class
Public Partial Class SystemSettingsResponse
Public Sub New()
LanguageOptions = New List(Of LanguageResponse)
End Sub
'''<Summary>
'''The country options to choose from
'''</Summary>
<ApiMember(Description:="The country options to choose from")>
Public Overridable Property LanguageOptions As List(Of LanguageResponse)
'''<Summary>
'''If the booking is active or not
'''</Summary>
<ApiMember(DataType:="bool", Description:="If the booking is active or not")>
Public Overridable Property Active As Boolean
'''<Summary>
'''If the booking is not active, what message to show to the customers
'''</Summary>
<ApiMember(DataType:="string", Description:="If the booking is not active, what message to show to the customers")>
Public Overridable Property InactiveMessage As String
'''<Summary>
'''If the company should be visible in search results on hompage
'''</Summary>
<ApiMember(DataType:="bool", Description:="If the company should be visible in search results on hompage")>
Public Overridable Property Searchable As Boolean
'''<Summary>
'''If you have a google analytics account and want to track your customers behaviors.
'''</Summary>
<ApiMember(DataType:="string", Description:="If you have a google analytics account and want to track your customers behaviors.")>
Public Overridable Property GATrackingId As String
'''<Summary>
'''If you have a google Ads Conversion Id account and want to track your customers behaviors.
'''</Summary>
<ApiMember(DataType:="string", Description:="If you have a google Ads Conversion Id account and want to track your customers behaviors.")>
Public Overridable Property GoogleAdsConversionId As String
'''<Summary>
'''If you have a LinkedIn account and want to track your customers behaviors.
'''</Summary>
<ApiMember(DataType:="string", Description:="If you have a LinkedIn account and want to track your customers behaviors.")>
Public Overridable Property LinkedinTagId As String
'''<Summary>
'''If you have a Google Ads Conversion Label and want to track your customers behaviors.
'''</Summary>
<ApiMember(DataType:="string", Description:="If you have a Google Ads Conversion Label and want to track your customers behaviors.")>
Public Overridable Property GoogleAdsConversionLabel As String
'''<Summary>
'''If you have a google tag manager account and want to track your customers behaviors.
'''</Summary>
<ApiMember(DataType:="string", Description:="If you have a google tag manager account and want to track your customers behaviors.")>
Public Overridable Property GTMTrackingId As String
'''<Summary>
'''If you have a facebook account and want to track your customers behaviors.
'''</Summary>
<ApiMember(DataType:="string", Description:="If you have a facebook account and want to track your customers behaviors.")>
Public Overridable Property FacebookPixelId As String
'''<Summary>
'''If the company should be visible on the marketplace
'''</Summary>
<ApiMember(DataType:="bool", Description:="If the company should be visible on the marketplace")>
Public Overridable Property ShowOnMarketplace As Boolean
'''<Summary>
'''If you want your customers to be albe to change language on your homepage
'''</Summary>
<ApiMember(DataType:="bool", Description:="If you want your customers to be albe to change language on your homepage")>
Public Overridable Property MultiLanguage As Boolean
'''<Summary>
'''If you want your own written text on your homepage to be translated using google analytics when a user changes language
'''</Summary>
<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 Overridable Property EnableAPITranslation As Boolean
'''<Summary>
'''What is the standard language your homepage information is written in. Select from the different countries, ie. SE,NO,EN
'''</Summary>
<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 Overridable Property DefaultLanguage As String
'''<Summary>
'''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.
'''</Summary>
<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 Overridable Property SendCustomerInformationToExternalProviders As Boolean
End Class
End Namespace
End Namespace
VB.NET SystemSettingQuery DTOs
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.
GET /settings/system HTTP/1.1 Host: api.bokamera.se Accept: application/xml
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>