BokaMera.API.Host

<back to all web services

RecurringScheduleIntervalsQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/schedules/recurring/intervalsGet the schedule intervalsGet the schedule intervals. Note: This must not be the same as the available times.
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
{
    [ValidateRequest("IsAuthenticated")]
    public partial class RecurringScheduleIntervalsQuery
        : ICompany, IInterval
    {
        public RecurringScheduleIntervalsQuery()
        {
            ResourceIds = new int[]{};
        }

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

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

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

        ///<summary>
        ///Here you can select one of the resource, if none is selected it will show available times for all
        ///</summary>
        [ApiMember(Description="Here you can select one of the resource, if none is selected it will show available times for all", ParameterType="query")]
        public virtual int[] ResourceIds { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class ScheduleIntervalsQueryResponse
    {
        public virtual DateTime From { get; set; }
        public virtual DateTime To { get; set; }
        public virtual TimeSpan Duration { get; set; }
    }

}

C# RecurringScheduleIntervalsQuery 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 /schedules/recurring/intervals HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ScheduleIntervalsQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Duration>PT0S</Duration>
  <From>0001-01-01T00:00:00</From>
  <To>0001-01-01T00:00:00</To>
</ScheduleIntervalsQueryResponse>