GET | /services/{ServiceId}/availabletimes/grouped | Get availabletimes for the service | Get availabletimes for the service and it's connected schedules |
---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class AvaiableTimesGroupedQuery : IInterval
{
/**
* Company to show services for
*/
@ApiMember(Description="Company to show services for", ParameterType="query")
var CompanyId:UUID? = null
/**
* Service id
*/
@ApiMember(Description="Service id", IsRequired=true, ParameterType="path")
var ServiceId:Int? = null
/**
* 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
/**
* Here you can select one of the resource in each resourcetype 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 resourcetype connected to the service, if none is selected it will show available times for all", ParameterType="query")
var Resources:ArrayList<AvailableTimesResourceTypeResource> = ArrayList<AvailableTimesResourceTypeResource>()
/**
* Here you select number of resources to book (in each resourcetype). Default is 1.
*/
@ApiMember(Description="Here you select number of resources to book (in each resourcetype). Default is 1.", ParameterType="query")
var NumberOfResources:Int? = null
/**
* If you want to include the connected resourcetypes and resources
*/
@ApiMember(Description="If you want to include the connected resourcetypes and resources", ParameterType="query")
var ShowPerResource:Boolean? = null
/**
* Both start and time time should be inside test interval. Default is false which means only start time needs to be inside.
*/
@ApiMember(DataType="bool", Description="Both start and time time should be inside test interval. Default is false which means only start time needs to be inside.", ParameterType="query")
var InsideSearchInterval:Boolean? = 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")
var Duration:Int? = null
var ResponseStatus:ResponseStatus? = null
}
open class AvailableTimesResourceTypeResource
{
/**
* The resourcetype id
*/
@ApiMember(Description="The resourcetype id")
var ResourceTypeId:Int? = null
/**
* The resource id
*/
@ApiMember(Description="The resource id")
var ResourceId:Int? = null
}
open class AvailableTimesGroupedDatesResponse
{
var CompanyId:UUID? = null
var ServiceId:Int? = null
var TimesFreeTextSingle:String? = null
var TimesFreeTextMultiple:String? = null
var Items:ArrayList<AvailableTimesGroupedDates> = ArrayList<AvailableTimesGroupedDates>()
}
open class AvailableTimesGroupedDates
{
var Group:Date? = 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
}
Kotlin AvaiableTimesGroupedQuery DTOs
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.
GET /services/{ServiceId}/availabletimes/grouped HTTP/1.1 Host: api.bokamera.se Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <AvailableTimesGroupedDatesResponse 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> <Items> <AvailableTimesGroupedDates> <Group>0001-01-01T00:00:00</Group> <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> </AvailableTimesGroupedDates> </Items> <ServiceId>0</ServiceId> <TimesFreeTextMultiple>String</TimesFreeTextMultiple> <TimesFreeTextSingle>String</TimesFreeTextSingle> </AvailableTimesGroupedDatesResponse>