Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
POST | /schedules/date/test | Test date schedule | Test date schedule, only administrators are allowed to test schedules. |
---|
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 AddDateScheduleDate
{
///<summary>
///The from date for the timeslot
///</summary>
[ApiMember(Description="The from date for the timeslot", IsRequired=true)]
public virtual DateTime From { get; set; }
///<summary>
///The to date for the timeslot
///</summary>
[ApiMember(Description="The to date for the timeslot", IsRequired=true)]
public virtual DateTime To { 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; }
}
[ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
[ValidateRequest("IsAuthenticated")]
public partial class TestDateSchedule
: ICompany, IInterval
{
public TestDateSchedule()
{
ScheduleDates = new List<AddDateScheduleDate>{};
}
///<summary>
///The company id, if empty will use the company id for the user you are logged in with.
///</summary>
[ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
public virtual Guid? CompanyId { get; set; }
///<summary>
///The dates for the schedule. This is the actual timeslots.
///</summary>
[ApiMember(Description="The dates for the schedule. This is the actual timeslots.", IsRequired=true)]
public virtual List<AddDateScheduleDate> ScheduleDates { 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>
///The Service Duration
///</summary>
[ApiMember(Description="The Service Duration")]
public virtual int? ServiceId { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>