BokaMera.API.Host

<back to all web services

NextFreeTimeQuery

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 AvailableTimesResourceTypeResource
    {
        ///<summary>
        ///The resourcetype id
        ///</summary>
        [ApiMember(Description="The resourcetype id")]
        public virtual int ResourceTypeId { get; set; }

        ///<summary>
        ///The resource id
        ///</summary>
        [ApiMember(Description="The resource id")]
        public virtual int ResourceId { get; set; }
    }

    public partial class AvailableTimesResponse
    {
        public AvailableTimesResponse()
        {
            Times = new List<AvailableTimesSum>{};
        }

        public virtual Guid CompanyId { get; set; }
        public virtual int ServiceId { get; set; }
        public virtual string TimesFreeTextSingle { get; set; }
        public virtual string TimesFreeTextMultiple { get; set; }
        public virtual List<AvailableTimesSum> Times { get; set; }
    }

    public partial class AvailableTimesSum
        : IAvailableTime
    {
        public virtual DateTime From { get; set; }
        public virtual DateTime To { get; set; }
        public virtual int Free { get; set; }
        public virtual int FreeSpots { get; set; }
        public virtual IEnumerable<ExceptionText> ExceptionTexts { get; set; }
    }

    public partial class ExceptionText
    {
        public virtual string Reason { get; set; }
        public virtual string ReasonPublic { get; set; }
    }

    public partial class NextFreeTimeQuery
        : IInterval
    {
        public NextFreeTimeQuery()
        {
            Resources = new List<AvailableTimesResourceTypeResource>{};
        }

        ///<summary>
        ///Company to show available time for
        ///</summary>
        [ApiMember(Description="Company to show available time for", ParameterType="query")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///Service id
        ///</summary>
        [ApiMember(Description="Service id", IsRequired=true, ParameterType="path")]
        public virtual int ServiceId { get; set; }

        ///<summary>
        ///From what datetime to search available times
        ///</summary>
        [ApiMember(DataType="dateTime", Description="From what datetime to search available times", IsRequired=true, ParameterType="query")]
        public virtual DateTime From { get; set; }

        ///<summary>
        ///To what datetime to show available times. Optional, if no datetime is set it will search one year
        ///</summary>
        [ApiMember(DataType="dateTime", Description="To what datetime to show available times. Optional, if no datetime is set it will search one year", IsRequired=true, ParameterType="query")]
        public virtual DateTime To { get; set; }

        ///<summary>
        ///Here you can select one of the resource in each resource type connected to the service, if none is selected it will show available times for all
        ///</summary>
        [ApiMember(Description="Here you can select one of the resource in each resource type connected to the service, if none is selected it will show available times for all", ParameterType="query")]
        public virtual List<AvailableTimesResourceTypeResource> Resources { get; set; }

        ///<summary>
        ///Here you select number of resources to book (in each resource type). Default is 1.
        ///</summary>
        [ApiMember(Description="Here you select number of resources to book (in each resource type). Default is 1.", ParameterType="query")]
        public virtual int NumberOfResources { get; set; }

        ///<summary>
        ///The duration you want to book. Needs to withing the service Min and Max. If not set it will use the service duration
        ///</summary>
        [ApiMember(DataType="bool", Description="The duration you want to book. Needs to withing the service Min and Max. If not set it will use the service duration", ParameterType="query")]
        public virtual int? Duration { get; set; }

        ///<summary>
        ///If you want to include the connected resource types and resources
        ///</summary>
        [ApiMember(Description="If you want to include the connected resource types and resources", ParameterType="query")]
        public virtual bool ShowPerResource { get; set; }
    }

}

C# NextFreeTimeQuery DTOs

GET /services/{ServiceId}/nextfreetime HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv

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

{"ServiceId":0,"TimesFreeTextSingle":"String","TimesFreeTextMultiple":"String","Times":[{"Free":0,"FreeSpots":0}]}