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.

export class LanguageResponse
{
    public Id: string;
    public Name: string;

    public constructor(init?: Partial<LanguageResponse>) { (Object as any).assign(this, init); }
}

export class SystemSettingsResponse
{
    /** @description The country options to choose from */
    // @ApiMember(Description="The country options to choose from")
    public LanguageOptions: LanguageResponse[];

    /** @description If the booking is active or not */
    // @ApiMember(DataType="bool", Description="If the booking is active or not")
    public Active: boolean;

    /** @description 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 InactiveMessage: string;

    /** @description 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 Searchable: boolean;

    /** @description 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 GATrackingId: string;

    /** @description 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 GoogleAdsConversionId: string;

    /** @description 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 LinkedinTagId: string;

    /** @description 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 GoogleAdsConversionLabel: string;

    /** @description 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 GTMTrackingId: string;

    /** @description 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 FacebookPixelId: string;

    /** @description If the company should be visible on the marketplace */
    // @ApiMember(DataType="bool", Description="If the company should be visible on the marketplace")
    public ShowOnMarketplace: boolean;

    /** @description 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 MultiLanguage: boolean;

    /** @description 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 EnableAPITranslation: boolean;

    /** @description 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 DefaultLanguage: string;

    /** @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.  */
    // @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 SendCustomerInformationToExternalProviders: boolean;

    public constructor(init?: Partial<SystemSettingsResponse>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
export class SystemSettingQuery
{
    /** @description If you want to include the language options to select from */
    // @ApiMember(DataType="boolean", Description="If you want to include the language options to select from", ParameterType="query")
    public IncludeLanguageOptions: boolean;

    public constructor(init?: Partial<SystemSettingQuery>) { (Object as any).assign(this, init); }
}

TypeScript SystemSettingQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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}