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.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @ValidateRequest(Validator="IsAuthenticated")
    public static class RecurringScheduleIntervalsQuery implements ICompany, IInterval
    {
        /**
        * Company to show services for
        */
        @ApiMember(Description="Company to show services for", ParameterType="query")
        public UUID CompanyId = null;

        /**
        * From what datetime to show times
        */
        @ApiMember(DataType="dateTime", Description="From what datetime to show times", IsRequired=true, ParameterType="query")
        public Date From = null;

        /**
        * To what datetime to show times
        */
        @ApiMember(DataType="dateTime", Description="To what datetime to show times", IsRequired=true, ParameterType="query")
        public Date To = null;

        /**
        * Here you can select one of the resource, if none is selected it will show available times for all
        */
        @ApiMember(Description="Here you can select one of the resource, if none is selected it will show available times for all", ParameterType="query")
        public ArrayList<Integer> ResourceIds = null;

        public ResponseStatus ResponseStatus = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public RecurringScheduleIntervalsQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Date getFrom() { return From; }
        public RecurringScheduleIntervalsQuery setFrom(Date value) { this.From = value; return this; }
        public Date getTo() { return To; }
        public RecurringScheduleIntervalsQuery setTo(Date value) { this.To = value; return this; }
        public ArrayList<Integer> getResourceIds() { return ResourceIds; }
        public RecurringScheduleIntervalsQuery setResourceIds(ArrayList<Integer> value) { this.ResourceIds = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public RecurringScheduleIntervalsQuery setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class ScheduleIntervalsQueryResponse
    {
        public Date From = null;
        public Date To = null;
        public TimeSpan Duration = null;
        
        public Date getFrom() { return From; }
        public ScheduleIntervalsQueryResponse setFrom(Date value) { this.From = value; return this; }
        public Date getTo() { return To; }
        public ScheduleIntervalsQueryResponse setTo(Date value) { this.To = value; return this; }
        public TimeSpan getDuration() { return Duration; }
        public ScheduleIntervalsQueryResponse setDuration(TimeSpan value) { this.Duration = value; return this; }
    }

}

Java RecurringScheduleIntervalsQuery DTOs

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

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Duration":"00:00:00"}