BokaMera.API.Host

<back to all web services

TestDateSchedule

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/schedules/date/testTest date scheduleTest date schedule, only administrators are allowed to test schedules.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
    @ValidateRequest(Validator="IsAuthenticated")
    public static class TestDateSchedule implements ICompany, IInterval
    {
        /**
        * The company id, if empty will use the company id for the user you are logged in with.
        */
        @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
        public UUID CompanyId = null;

        /**
        * The dates for the schedule. This is the actual timeslots.
        */
        @ApiMember(Description="The dates for the schedule. This is the actual timeslots.", IsRequired=true)
        public ArrayList<AddDateScheduleDate> ScheduleDates = null;

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

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

        /**
        * The Service Duration
        */
        @ApiMember(Description="The Service Duration")
        public Integer ServiceId = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public TestDateSchedule setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public ArrayList<AddDateScheduleDate> getScheduleDates() { return ScheduleDates; }
        public TestDateSchedule setScheduleDates(ArrayList<AddDateScheduleDate> value) { this.ScheduleDates = value; return this; }
        public Date getFrom() { return From; }
        public TestDateSchedule setFrom(Date value) { this.From = value; return this; }
        public Date getTo() { return To; }
        public TestDateSchedule setTo(Date value) { this.To = value; return this; }
        public Integer getServiceId() { return ServiceId; }
        public TestDateSchedule setServiceId(Integer value) { this.ServiceId = value; return this; }
    }

    public static class AddDateScheduleDate
    {
        /**
        * The from date for the timeslot
        */
        @ApiMember(Description="The from date for the timeslot", IsRequired=true)
        public Date From = null;

        /**
        * The to date for the timeslot
        */
        @ApiMember(Description="The to date for the timeslot", IsRequired=true)
        public Date To = null;
        
        public Date getFrom() { return From; }
        public AddDateScheduleDate setFrom(Date value) { this.From = value; return this; }
        public Date getTo() { return To; }
        public AddDateScheduleDate setTo(Date value) { this.To = value; return this; }
    }

    public static class AvailableTimesResponse
    {
        public UUID CompanyId = null;
        public Integer ServiceId = null;
        public String TimesFreeTextSingle = null;
        public String TimesFreeTextMultiple = null;
        public ArrayList<AvailableTimesSum> Times = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public AvailableTimesResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Integer getServiceId() { return ServiceId; }
        public AvailableTimesResponse setServiceId(Integer value) { this.ServiceId = value; return this; }
        public String getTimesFreeTextSingle() { return TimesFreeTextSingle; }
        public AvailableTimesResponse setTimesFreeTextSingle(String value) { this.TimesFreeTextSingle = value; return this; }
        public String getTimesFreeTextMultiple() { return TimesFreeTextMultiple; }
        public AvailableTimesResponse setTimesFreeTextMultiple(String value) { this.TimesFreeTextMultiple = value; return this; }
        public ArrayList<AvailableTimesSum> getTimes() { return Times; }
        public AvailableTimesResponse setTimes(ArrayList<AvailableTimesSum> value) { this.Times = value; return this; }
    }

    public static class AvailableTimesSum implements IAvailableTime
    {
        public Date From = null;
        public Date To = null;
        public Integer Free = null;
        public Integer FreeSpots = null;
        public ArrayList<ExceptionText> ExceptionTexts = null;
        
        public Date getFrom() { return From; }
        public AvailableTimesSum setFrom(Date value) { this.From = value; return this; }
        public Date getTo() { return To; }
        public AvailableTimesSum setTo(Date value) { this.To = value; return this; }
        public Integer getFree() { return Free; }
        public AvailableTimesSum setFree(Integer value) { this.Free = value; return this; }
        public Integer getFreeSpots() { return FreeSpots; }
        public AvailableTimesSum setFreeSpots(Integer value) { this.FreeSpots = value; return this; }
        public ArrayList<ExceptionText> getExceptionTexts() { return ExceptionTexts; }
        public AvailableTimesSum setExceptionTexts(ArrayList<ExceptionText> value) { this.ExceptionTexts = value; return this; }
    }

    public static class ExceptionText
    {
        public String Reason = null;
        public String ReasonPublic = null;
        
        public String getReason() { return Reason; }
        public ExceptionText setReason(String value) { this.Reason = value; return this; }
        public String getReasonPublic() { return ReasonPublic; }
        public ExceptionText setReasonPublic(String value) { this.ReasonPublic = value; return this; }
    }

}

Java TestDateSchedule 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.

POST /schedules/date/test HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TestDateSchedule 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>
  <From>0001-01-01T00:00:00</From>
  <ScheduleDates>
    <AddDateScheduleDate>
      <From>0001-01-01T00:00:00</From>
      <To>0001-01-01T00:00:00</To>
    </AddDateScheduleDate>
  </ScheduleDates>
  <ServiceId>0</ServiceId>
  <To>0001-01-01T00:00:00</To>
</TestDateSchedule>
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>