GET | /services/{ServiceId}/nextfreetime | Get the next available time for the service | Get the next available time for the service |
---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class NextFreeTimeQuery : IInterval
{
/**
* Company to show available time for
*/
@ApiMember(Description="Company to show available time for", ParameterType="query")
open var CompanyId:UUID? = null
/**
* Service id
*/
@ApiMember(Description="Service id", IsRequired=true, ParameterType="path")
open var ServiceId:Int? = null
/**
* From what datetime to search available times
*/
@ApiMember(DataType="dateTime", Description="From what datetime to search available times", IsRequired=true, ParameterType="query")
override var From:Date? = null
/**
* To what datetime to show available times. Optional, if no datetime is set it will search one year
*/
@ApiMember(DataType="dateTime", Description="To what datetime to show available times. Optional, if no datetime is set it will search one year", IsRequired=true, ParameterType="query")
override var To:Date? = null
/**
* Here you can select one of the resource in each resource type connected to the service, if none is selected it will show available times for all
*/
@ApiMember(Description="Here you can select one of the resource in each resource type connected to the service, if none is selected it will show available times for all", ParameterType="query")
open var Resources:ArrayList<AvailableTimesResourceTypeResource>? = null
/**
* Here you select number of resources to book (in each resource type). Default is 1.
*/
@ApiMember(Description="Here you select number of resources to book (in each resource type). Default is 1.", ParameterType="query")
open var NumberOfResources:Int? = null
/**
* The duration you want to book. Needs to withing the service Min and Max. If not set it will use the service duration
*/
@ApiMember(DataType="bool", Description="The duration you want to book. Needs to withing the service Min and Max. If not set it will use the service duration", ParameterType="query")
open var Duration:Int? = null
/**
* If you want to include the connected resource types and resources
*/
@ApiMember(Description="If you want to include the connected resource types and resources", ParameterType="query")
open var ShowPerResource:Boolean? = null
}
open class AvailableTimesResourceTypeResource
{
/**
* The resourcetype id
*/
@ApiMember(Description="The resourcetype id")
open var ResourceTypeId:Int? = null
/**
* The resource id
*/
@ApiMember(Description="The resource id")
open var ResourceId:Int? = null
}
open class AvailableTimesResponse
{
open var CompanyId:UUID? = null
open var ServiceId:Int? = null
open var TimesFreeTextSingle:String? = null
open var TimesFreeTextMultiple:String? = null
open var Times:ArrayList<AvailableTimesSum>? = null
}
open class AvailableTimesSum : IAvailableTime
{
open var From:Date? = null
open var To:Date? = null
override var Free:Int? = null
open var FreeSpots:Int? = null
open var ExceptionTexts:ArrayList<ExceptionText>? = null
}
open class ExceptionText
{
open var Reason:String? = null
open var ReasonPublic:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /services/{ServiceId}/nextfreetime HTTP/1.1 Host: api.bookmore.com Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { ServiceId: 0, TimesFreeTextSingle: String, TimesFreeTextMultiple: String, Times: [ { Free: 0, FreeSpots: 0 } ] }