| 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. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class TestDateSchedule : 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.")
var CompanyId:UUID? = 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)
var ScheduleDates:ArrayList<AddDateScheduleDate> = ArrayList<AddDateScheduleDate>()
/**
* From what datetime to show available times
*/
@ApiMember(DataType="dateTime", Description="From what datetime to show available times", IsRequired=true, ParameterType="query")
var From:Date? = null
/**
* To what datetime to show available times
*/
@ApiMember(DataType="dateTime", Description="To what datetime to show available times", IsRequired=true, ParameterType="query")
var To:Date? = null
/**
* The Service Duration
*/
@ApiMember(Description="The Service Duration")
var ServiceId:Int? = null
}
open class AddDateScheduleDate
{
/**
* The from date for the timeslot
*/
@ApiMember(Description="The from date for the timeslot", IsRequired=true)
var From:Date? = null
/**
* The to date for the timeslot
*/
@ApiMember(Description="The to date for the timeslot", IsRequired=true)
var To:Date? = null
}
open class AvailableTimesResponse
{
var CompanyId:UUID? = null
var ServiceId:Int? = null
var TimesFreeTextSingle:String? = null
var TimesFreeTextMultiple:String? = null
var Times:ArrayList<AvailableTimesSum> = ArrayList<AvailableTimesSum>()
}
open class AvailableTimesSum : IAvailableTime
{
var From:Date? = null
var To:Date? = null
var Free:Int? = null
var FreeSpots:Int? = null
var ExceptionTexts:ArrayList<ExceptionText> = ArrayList<ExceptionText>()
}
open class ExceptionText
{
var Reason:String? = null
var ReasonPublic:String? = null
}
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>