BokaMera.API.Host

<back to all web services

HomepageWidgetSettingsQuery

The following routes are available for this service:
GET/homepage/widget/settingsGet homepage widget settingsGet homepage widget settings on the company of the currently logged in user, only administrators are allowed to update homepage menu.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class HomepageWidgetBookingLayoutsResponse
    {
        ///<summary>
        ///The layout id.
        ///</summary>
        [ApiMember(Description="The layout id.")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The layout name.
        ///</summary>
        [ApiMember(Description="The layout name.")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The layout description.
        ///</summary>
        [ApiMember(Description="The layout description.")]
        public virtual string Description { get; set; }

        ///<summary>
        ///The layout code.
        ///</summary>
        [ApiMember(Description="The layout code.")]
        public virtual string Code { get; set; }
    }

    public partial class HomepageWidgetBookingMethodsResponse
    {
        ///<summary>
        ///The layout id.
        ///</summary>
        [ApiMember(Description="The layout id.")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The layout name.
        ///</summary>
        [ApiMember(Description="The layout name.")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The layout description.
        ///</summary>
        [ApiMember(Description="The layout description.")]
        public virtual string Description { get; set; }

        ///<summary>
        ///The layout code.
        ///</summary>
        [ApiMember(Description="The layout code.")]
        public virtual string Code { get; set; }
    }

    public partial class HomepageWidgetServiceLayoutsResponse
    {
        ///<summary>
        ///The layout id.
        ///</summary>
        [ApiMember(Description="The layout id.")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The layout name.
        ///</summary>
        [ApiMember(Description="The layout name.")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The layout description.
        ///</summary>
        [ApiMember(Description="The layout description.")]
        public virtual string Description { get; set; }

        ///<summary>
        ///The layout code.
        ///</summary>
        [ApiMember(Description="The layout code.")]
        public virtual string Code { get; set; }
    }

    public partial class HomepageWidgetSettingsQuery
        : ICompany, ICompanyRequest
    {
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///The homepage sitepath.
        ///</summary>
        [ApiMember(Description="The homepage sitepath.")]
        public virtual string SitePath { get; set; }

        ///<summary>
        ///If you want to include what service layout options to select from
        ///</summary>
        [ApiMember(Description="If you want to include what service layout options to select from")]
        public virtual bool IncludeServiceLayoutOptions { get; set; }

        ///<summary>
        ///If you want to include what time layout options to select from
        ///</summary>
        [ApiMember(Description="If you want to include what time layout options to select from")]
        public virtual bool IncludeTimeLayoutOptions { get; set; }

        ///<summary>
        ///If you want to include what booking layout options to select from
        ///</summary>
        [ApiMember(Description="If you want to include what booking layout options to select from")]
        public virtual bool IncludeBookingLayoutOptions { get; set; }

        ///<summary>
        ///If you want to include what booking method options to select from
        ///</summary>
        [ApiMember(Description="If you want to include what booking method options to select from")]
        public virtual bool IncludeBookingMethodOptions { get; set; }
    }

    public partial class HomepageWidgetSettingsQueryResponse
    {
        public HomepageWidgetSettingsQueryResponse()
        {
            ServiceLayoutOptions = new List<HomepageWidgetServiceLayoutsResponse>{};
            TimeLayoutOptions = new List<HomepageWidgetTimeLayoutsResponse>{};
            BookingLayoutOptions = new List<HomepageWidgetBookingLayoutsResponse>{};
            BookingMethodOptions = new List<HomepageWidgetBookingMethodsResponse>{};
        }

        ///<summary>
        ///The company id.
        ///</summary>
        [ApiMember(Description="The company id.")]
        public virtual Guid CompanyId { get; set; }

        ///<summary>
        ///The service layouts id.
        ///</summary>
        [ApiMember(Description="The service layouts id.")]
        public virtual int ServiceLayoutId { get; set; }

        ///<summary>
        ///The time layouts id.
        ///</summary>
        [ApiMember(Description="The time layouts id.")]
        public virtual int TimeLayoutId { get; set; }

        ///<summary>
        ///The booking layouts id.
        ///</summary>
        [ApiMember(Description="The booking layouts id.")]
        public virtual int BookingLayoutId { get; set; }

        ///<summary>
        ///The primary color of the booking widget.
        ///</summary>
        [ApiMember(Description="The primary color of the booking widget.")]
        public virtual string PrimaryColor { get; set; }

        ///<summary>
        ///If you should show the service image in the booking widget.
        ///</summary>
        [ApiMember(Description="If you should show the service image in the booking widget.")]
        public virtual bool ShowServiceImage { get; set; }

        ///<summary>
        ///If you should show the rebate code field in the booking widget.
        ///</summary>
        [ApiMember(Description="If you should show the rebate code field in the booking widget.")]
        public virtual bool ShowRebateCodeField { get; set; }

        ///<summary>
        ///If you should show the next available time in the booking widget.
        ///</summary>
        [ApiMember(Description="If you should show the next available time in the booking widget.")]
        public virtual bool ShowNextAvailableTime { get; set; }

        ///<summary>
        ///If you should show the subscribe to newsletter checkbox in the booking widget.
        ///</summary>
        [ApiMember(Description="If you should show the subscribe to newsletter checkbox in the booking widget.")]
        public virtual bool ShowSubscribeToNewsletter { get; set; }

        ///<summary>
        ///If you should show the create account option.
        ///</summary>
        [ApiMember(Description="If you should show the create account option.")]
        public virtual bool EnableCreateAccount { get; set; }

        ///<summary>
        ///If you should show the login to account option.
        ///</summary>
        [ApiMember(Description="If you should show the login to account option.")]
        public virtual bool EnableLogin { get; set; }

        ///<summary>
        ///If you should show the facebook login to account option.
        ///</summary>
        [ApiMember(Description="If you should show the facebook login to account option.")]
        public virtual bool EnableFacebookLogin { get; set; }

        ///<summary>
        ///If you should show the direct booking option. This enables customer to book with entering contact information.
        ///</summary>
        [ApiMember(Description="If you should show the direct booking option. This enables customer to book with entering contact information.")]
        public virtual bool EnableDirectBooking { get; set; }

        ///<summary>
        ///If the site should have dark theme or not.
        ///</summary>
        [ApiMember(Description="If the site should have dark theme or not.")]
        public virtual bool DarkTheme { get; set; }

        ///<summary>
        ///If you should show the end time in the booking widget.
        ///</summary>
        [ApiMember(Description="If you should show the end time in the booking widget.")]
        public virtual bool ShowEndTime { get; set; }

        ///<summary>
        ///What text to show on booked time slots. Default text is Booked
        ///</summary>
        [ApiMember(Description="What text to show on booked time slots. Default text is Booked")]
        public virtual string BookedTimeSlotText { get; set; }

        public virtual List<HomepageWidgetServiceLayoutsResponse> ServiceLayoutOptions { get; set; }
        public virtual List<HomepageWidgetTimeLayoutsResponse> TimeLayoutOptions { get; set; }
        public virtual List<HomepageWidgetBookingLayoutsResponse> BookingLayoutOptions { get; set; }
        public virtual List<HomepageWidgetBookingMethodsResponse> BookingMethodOptions { get; set; }
    }

    public partial class HomepageWidgetTimeLayoutsResponse
    {
        ///<summary>
        ///The layout id.
        ///</summary>
        [ApiMember(Description="The layout id.")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The layout name.
        ///</summary>
        [ApiMember(Description="The layout name.")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The layout description.
        ///</summary>
        [ApiMember(Description="The layout description.")]
        public virtual string Description { get; set; }

        ///<summary>
        ///The layout code.
        ///</summary>
        [ApiMember(Description="The layout code.")]
        public virtual string Code { get; set; }
    }

}

C# HomepageWidgetSettingsQuery 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 /homepage/widget/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ServiceLayoutId":0,"TimeLayoutId":0,"BookingLayoutId":0,"PrimaryColor":"String","ShowServiceImage":false,"ShowRebateCodeField":false,"ShowNextAvailableTime":false,"ShowSubscribeToNewsletter":false,"EnableCreateAccount":false,"EnableLogin":false,"EnableFacebookLogin":false,"EnableDirectBooking":false,"DarkTheme":false,"ShowEndTime":false,"BookedTimeSlotText":"String","ServiceLayoutOptions":[{"Id":0,"Name":"String","Description":"String","Code":"String"}],"TimeLayoutOptions":[{"Id":0,"Name":"String","Description":"String","Code":"String"}],"BookingLayoutOptions":[{"Id":0,"Name":"String","Description":"String","Code":"String"}],"BookingMethodOptions":[{"Id":0,"Name":"String","Description":"String","Code":"String"}]}