BokaMera.API.Host

<back to all web services

NextFreeTimeQuery

import java.math.*
import java.util.*
import net.servicestack.client.*


open class NextFreeTimeQuery : IInterval
{
    /**
    * Company to show available time for
    */
    @ApiMember(Description="Company to show available time 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 search available times
    */
    @ApiMember(DataType="dateTime", Description="From what datetime to search available times", IsRequired=true, ParameterType="query")
    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")
    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")
    var Resources:ArrayList<AvailableTimesResourceTypeResource> = ArrayList<AvailableTimesResourceTypeResource>()

    /**
    * 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")
    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")
    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")
    var ShowPerResource:Boolean? = 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 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
}

Kotlin NextFreeTimeQuery DTOs

GET /services/{ServiceId}/nextfreetime HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ServiceId":0,"TimesFreeTextSingle":"String","TimesFreeTextMultiple":"String","Times":[{"Free":0,"FreeSpots":0}]}