BokaMera.API.Host

<back to all web services

SystemSettingQuery

The following routes are available for this service:
GET/settings/systemGet system settings for the currently logged in userGet 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
        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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: testapi.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}