BokaMera.API.Host

<back to all web services

AvailableTimesQuery

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 AvailableTimesQuery
        : IInterval
    {
        public AvailableTimesQuery()
        {
            Resources = new List<AvailableTimesResourceTypeResource>{};
        }

        ///<summary>
        ///Company to show services for
        ///</summary>
        [ApiMember(Description="Company to show services 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 show available times
        ///</summary>
        [ApiMember(DataType="dateTime", Description="From what datetime to show available times", IsRequired=true, ParameterType="query")]
        public virtual DateTime From { get; set; }

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

        ///<summary>
        ///Here you can select one of the resource in each resourcetype 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 resourcetype 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 resourcetype). Default is 1.
        ///</summary>
        [ApiMember(Description="Here you select number of resources to book (in each resourcetype). Default is 1.", ParameterType="query")]
        public virtual int NumberOfResources { 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; }

        ///<summary>
        ///Both start and time time should be inside test interval. Default is false which means only start time needs to be inside.
        ///</summary>
        [ApiMember(DataType="bool", Description="Both start and time time should be inside test interval. Default is false which means only start time needs to be inside.", ParameterType="query")]
        public virtual bool InsideSearchInterval { 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; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    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; }
    }

}

C# AvailableTimesQuery DTOs

GET /services/{ServiceId}/availabletimes HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AvailableTimesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <ServiceId>0</ServiceId>
  <Times>
    <AvailableTimesSum>
      <ExceptionTexts i:nil="true" />
      <Free>0</Free>
      <FreeSpots>0</FreeSpots>
      <From>0001-01-01T00:00:00</From>
      <To>0001-01-01T00:00:00</To>
    </AvailableTimesSum>
  </Times>
  <TimesFreeTextMultiple>String</TimesFreeTextMultiple>
  <TimesFreeTextSingle>String</TimesFreeTextSingle>
</AvailableTimesResponse>