BokaMera.API.Host

<back to all web services

HomepageSchedulerSettingsQuery

The following routes are available for this service:
GET/homepage/scheduler/settingsGet homepage scheduler settings
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class HomepageSchedulerSettingsQuery implements ICompany, ICompanyRequest
    {
        /**
        * Enter the company you want to see news for, if blank and you are an admin, your company id will be used
        */
        @ApiMember(Description="Enter the company you want to see news for, if blank and you are an admin, your company id will be used", ParameterType="query")
        public UUID CompanyId = null;

        /**
        * If you want to include the services that is connected
        */
        @ApiMember(DataType="boolean", Description="If you want to include the services that is connected", ParameterType="query")
        public Boolean IncludeServices = null;

        /**
        * If you want to include the resources that is connected
        */
        @ApiMember(DataType="boolean", Description="If you want to include the resources that is connected", ParameterType="query")
        public Boolean IncludeResources = null;

        /**
        * If you want to include the scheduler fields that is connected
        */
        @ApiMember(DataType="boolean", Description="If you want to include the scheduler fields that is connected", ParameterType="query")
        public Boolean IncludeFields = null;

        /**
        * If you want to include the service to select from
        */
        @ApiMember(DataType="boolean", Description="If you want to include the service to select from", ParameterType="query")
        public Boolean IncludeServiceOptions = null;

        /**
        * If you want to include the resources to select from
        */
        @ApiMember(DataType="boolean", Description="If you want to include the resources to select from", ParameterType="query")
        public Boolean IncludeResourceOptions = null;

        /**
        * If you want to include the scheduler fields to select from
        */
        @ApiMember(DataType="boolean", Description="If you want to include the scheduler fields to select from", ParameterType="query")
        public Boolean IncludeFieldOptions = null;

        /**
        * If you want to include the schedule views to select from
        */
        @ApiMember(DataType="boolean", Description="If you want to include the schedule views to select from", ParameterType="query")
        public Boolean IncludeScheduleViewOptions = null;

        /**
        * The homeage sitepath.
        */
        @ApiMember(Description="The homeage sitepath.")
        public String SitePath = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public HomepageSchedulerSettingsQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Boolean isIncludeServices() { return IncludeServices; }
        public HomepageSchedulerSettingsQuery setIncludeServices(Boolean value) { this.IncludeServices = value; return this; }
        public Boolean isIncludeResources() { return IncludeResources; }
        public HomepageSchedulerSettingsQuery setIncludeResources(Boolean value) { this.IncludeResources = value; return this; }
        public Boolean isIncludeFields() { return IncludeFields; }
        public HomepageSchedulerSettingsQuery setIncludeFields(Boolean value) { this.IncludeFields = value; return this; }
        public Boolean isIncludeServiceOptions() { return IncludeServiceOptions; }
        public HomepageSchedulerSettingsQuery setIncludeServiceOptions(Boolean value) { this.IncludeServiceOptions = value; return this; }
        public Boolean isIncludeResourceOptions() { return IncludeResourceOptions; }
        public HomepageSchedulerSettingsQuery setIncludeResourceOptions(Boolean value) { this.IncludeResourceOptions = value; return this; }
        public Boolean isIncludeFieldOptions() { return IncludeFieldOptions; }
        public HomepageSchedulerSettingsQuery setIncludeFieldOptions(Boolean value) { this.IncludeFieldOptions = value; return this; }
        public Boolean isIncludeScheduleViewOptions() { return IncludeScheduleViewOptions; }
        public HomepageSchedulerSettingsQuery setIncludeScheduleViewOptions(Boolean value) { this.IncludeScheduleViewOptions = value; return this; }
        public String getSitePath() { return SitePath; }
        public HomepageSchedulerSettingsQuery setSitePath(String value) { this.SitePath = value; return this; }
    }

    public static class HomepageSchedulerSettingsQueryResponse
    {
        /**
        * The company id.
        */
        @ApiMember(Description="The company id.")
        public UUID CompanyId = null;

        /**
        * If the user schedule is activated.
        */
        @ApiMember(Description="If the user schedule is activated.")
        public Boolean Active = null;

        /**
        * If the user schedule views id.
        */
        @ApiMember(Description="If the user schedule views id.")
        public Integer ScheduleViewId = null;

        /**
        * If the user schedule time slots in minutes.
        */
        @ApiMember(Description="If the user schedule time slots in minutes.")
        public Integer ScheduleTimeSlotMinutes = null;

        /**
        * If the user schedule time start time.
        */
        @ApiMember(Description="If the user schedule time start time.")
        public TimeSpan StartTime = null;

        /**
        * If the user schedule time end time.
        */
        @ApiMember(Description="If the user schedule time end time.")
        public TimeSpan EndTime = null;

        /**
        * If the user schedule should contain time exceptions.
        */
        @ApiMember(Description="If the user schedule should contain time exceptions.")
        public Boolean ShowTimeExceptions = null;

        /**
        * If allow booking in the scheduler.
        */
        @ApiMember(Description="If allow booking in the scheduler.")
        public Boolean EnableBooking = null;

        /**
        * The homepage schedule services that are selected
        */
        @ApiMember(Description="The homepage schedule services that are selected")
        public ArrayList<HomepageSchedulerServiceResponse> Services = null;

        /**
        * The homepage schedule resources that are selected
        */
        @ApiMember(Description="The homepage schedule resources that are selected")
        public ArrayList<HomepageSchedulerResourceResponse> Resources = null;

        /**
        * The homepage schedule fields that are selected
        */
        @ApiMember(Description="The homepage schedule fields that are selected")
        public ArrayList<HomepageSchedulerFieldResponse> Fields = null;

        /**
        * The homepage schedule fields select from
        */
        @ApiMember(Description="The homepage schedule fields select from")
        public ArrayList<HomepageSchedulerFieldOptionsResponse> FieldOptions = null;

        /**
        * The available schedule view options to choose from
        */
        @ApiMember(Description="The available schedule view options to choose from")
        public ArrayList<ScheduleViewResponse> ScheduleViewOptions = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public HomepageSchedulerSettingsQueryResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Boolean isActive() { return Active; }
        public HomepageSchedulerSettingsQueryResponse setActive(Boolean value) { this.Active = value; return this; }
        public Integer getScheduleViewId() { return ScheduleViewId; }
        public HomepageSchedulerSettingsQueryResponse setScheduleViewId(Integer value) { this.ScheduleViewId = value; return this; }
        public Integer getScheduleTimeSlotMinutes() { return ScheduleTimeSlotMinutes; }
        public HomepageSchedulerSettingsQueryResponse setScheduleTimeSlotMinutes(Integer value) { this.ScheduleTimeSlotMinutes = value; return this; }
        public TimeSpan getStartTime() { return StartTime; }
        public HomepageSchedulerSettingsQueryResponse setStartTime(TimeSpan value) { this.StartTime = value; return this; }
        public TimeSpan getEndTime() { return EndTime; }
        public HomepageSchedulerSettingsQueryResponse setEndTime(TimeSpan value) { this.EndTime = value; return this; }
        public Boolean isShowTimeExceptions() { return ShowTimeExceptions; }
        public HomepageSchedulerSettingsQueryResponse setShowTimeExceptions(Boolean value) { this.ShowTimeExceptions = value; return this; }
        public Boolean isEnableBooking() { return EnableBooking; }
        public HomepageSchedulerSettingsQueryResponse setEnableBooking(Boolean value) { this.EnableBooking = value; return this; }
        public ArrayList<HomepageSchedulerServiceResponse> getServices() { return Services; }
        public HomepageSchedulerSettingsQueryResponse setServices(ArrayList<HomepageSchedulerServiceResponse> value) { this.Services = value; return this; }
        public ArrayList<HomepageSchedulerResourceResponse> getResources() { return Resources; }
        public HomepageSchedulerSettingsQueryResponse setResources(ArrayList<HomepageSchedulerResourceResponse> value) { this.Resources = value; return this; }
        public ArrayList<HomepageSchedulerFieldResponse> getFields() { return Fields; }
        public HomepageSchedulerSettingsQueryResponse setFields(ArrayList<HomepageSchedulerFieldResponse> value) { this.Fields = value; return this; }
        public ArrayList<HomepageSchedulerFieldOptionsResponse> getFieldOptions() { return FieldOptions; }
        public HomepageSchedulerSettingsQueryResponse setFieldOptions(ArrayList<HomepageSchedulerFieldOptionsResponse> value) { this.FieldOptions = value; return this; }
        public ArrayList<ScheduleViewResponse> getScheduleViewOptions() { return ScheduleViewOptions; }
        public HomepageSchedulerSettingsQueryResponse setScheduleViewOptions(ArrayList<ScheduleViewResponse> value) { this.ScheduleViewOptions = value; return this; }
    }

    public static class HomepageSchedulerServiceResponse
    {
        /**
        * The service id.
        */
        @ApiMember(Description="The service id.")
        public Integer Id = null;

        /**
        * The service name.
        */
        @ApiMember(Description="The service name.")
        public String Name = null;

        /**
        * The service description.
        */
        @ApiMember(Description="The service description.")
        public String Description = null;

        /**
        * The service image url.
        */
        @ApiMember(Description="The service image url.")
        public Uri ImageUrl = null;
        
        public Integer getId() { return Id; }
        public HomepageSchedulerServiceResponse setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public HomepageSchedulerServiceResponse setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public HomepageSchedulerServiceResponse setDescription(String value) { this.Description = value; return this; }
        public Uri getImageUrl() { return ImageUrl; }
        public HomepageSchedulerServiceResponse setImageUrl(Uri value) { this.ImageUrl = value; return this; }
    }

    public static class HomepageSchedulerResourceResponse
    {
        /**
        * The resource id.
        */
        @ApiMember(Description="The resource id.")
        public Integer Id = null;

        /**
        * The resource name.
        */
        @ApiMember(Description="The resource name.")
        public String Name = null;

        /**
        * The resource description.
        */
        @ApiMember(Description="The resource description.")
        public String Description = null;

        /**
        * The resource image url.
        */
        @ApiMember(Description="The resource image url.")
        public Uri ImageUrl = null;
        
        public Integer getId() { return Id; }
        public HomepageSchedulerResourceResponse setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public HomepageSchedulerResourceResponse setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public HomepageSchedulerResourceResponse setDescription(String value) { this.Description = value; return this; }
        public Uri getImageUrl() { return ImageUrl; }
        public HomepageSchedulerResourceResponse setImageUrl(Uri value) { this.ImageUrl = value; return this; }
    }

    public static class HomepageSchedulerFieldResponse
    {
        /**
        * The field id.
        */
        @ApiMember(Description="The field id.")
        public Integer Id = null;

        /**
        * If the field should be shown on booking.
        */
        @ApiMember(Description="If the field should be shown on booking.")
        public Boolean ShowOnBooking = null;

        /**
        * If the field should be shown on tooltip.
        */
        @ApiMember(Description="If the field should be shown on tooltip.")
        public Boolean ShowOnTooltip = null;
        
        public Integer getId() { return Id; }
        public HomepageSchedulerFieldResponse setId(Integer value) { this.Id = value; return this; }
        public Boolean isShowOnBooking() { return ShowOnBooking; }
        public HomepageSchedulerFieldResponse setShowOnBooking(Boolean value) { this.ShowOnBooking = value; return this; }
        public Boolean isShowOnTooltip() { return ShowOnTooltip; }
        public HomepageSchedulerFieldResponse setShowOnTooltip(Boolean value) { this.ShowOnTooltip = value; return this; }
    }

    public static class HomepageSchedulerFieldOptionsResponse
    {
        /**
        * The field id.
        */
        @ApiMember(Description="The field id.")
        public Integer Id = null;

        /**
        * The field name.
        */
        @ApiMember(Description="The field name.")
        public String Name = null;

        /**
        * The field description.
        */
        @ApiMember(Description="The field description.")
        public String Description = null;

        /**
        * The field sort order when listing.
        */
        @ApiMember(Description="The field sort order when listing.")
        public Integer SortOrder = null;
        
        public Integer getId() { return Id; }
        public HomepageSchedulerFieldOptionsResponse setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public HomepageSchedulerFieldOptionsResponse setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public HomepageSchedulerFieldOptionsResponse setDescription(String value) { this.Description = value; return this; }
        public Integer getSortOrder() { return SortOrder; }
        public HomepageSchedulerFieldOptionsResponse setSortOrder(Integer value) { this.SortOrder = value; return this; }
    }

    public static class ScheduleViewResponse
    {
        public Integer Id = null;
        public String Name = null;
        
        public Integer getId() { return Id; }
        public ScheduleViewResponse setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public ScheduleViewResponse setName(String value) { this.Name = value; return this; }
    }

}

Java HomepageSchedulerSettingsQuery DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /homepage/scheduler/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<HomepageSchedulerSettingsQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <EnableBooking>false</EnableBooking>
  <EndTime>PT0S</EndTime>
  <FieldOptions>
    <HomepageSchedulerFieldOptionsResponse>
      <Description>String</Description>
      <Id>0</Id>
      <Name>String</Name>
      <SortOrder>0</SortOrder>
    </HomepageSchedulerFieldOptionsResponse>
  </FieldOptions>
  <Fields>
    <HomepageSchedulerFieldResponse>
      <Id>0</Id>
      <ShowOnBooking>false</ShowOnBooking>
      <ShowOnTooltip>false</ShowOnTooltip>
    </HomepageSchedulerFieldResponse>
  </Fields>
  <Resources>
    <HomepageSchedulerResourceResponse>
      <Description>String</Description>
      <Id>0</Id>
      <ImageUrl i:nil="true" />
      <Name>String</Name>
    </HomepageSchedulerResourceResponse>
  </Resources>
  <ScheduleTimeSlotMinutes>0</ScheduleTimeSlotMinutes>
  <ScheduleViewId>0</ScheduleViewId>
  <ScheduleViewOptions>
    <ScheduleViewResponse>
      <Id>0</Id>
      <Name>String</Name>
    </ScheduleViewResponse>
  </ScheduleViewOptions>
  <Services>
    <HomepageSchedulerServiceResponse>
      <Description>String</Description>
      <Id>0</Id>
      <ImageUrl i:nil="true" />
      <Name>String</Name>
    </HomepageSchedulerServiceResponse>
  </Services>
  <ShowTimeExceptions>false</ShowTimeExceptions>
  <StartTime>PT0S</StartTime>
</HomepageSchedulerSettingsQueryResponse>