Reservation Station API

<back to all web services

GetFacilitySchedule

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


open class GetFacilitySchedule : ApiServiceRequest()
{
    var facilityId:Int? = null
    var start:Date? = null
    var end:Date? = null
}

open class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /**
    * The API Key required for authentication
    */
    @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    var apiKey:String? = null

    /**
    * Latitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Latitude of the user making this request")
    var latitude:Double? = null

    /**
    * Longitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Longitude of the user making this request")
    var longitude:Double? = null
}

open class GetFacilityScheduleResponse : ApiServiceResponse()
{
    var schedule:ArrayList<ScheduleDayData> = ArrayList<ScheduleDayData>()
    var bookAheadMaxDate:String? = null
    var openHour:Int? = null
    var closeHour:Int? = null
    var duration:Int? = null
    var isCoordinator:Boolean? = null
    var facilityTimeOffset:Int? = null
    var facility:FacilityData? = null
    var venueName:String? = null
    var allowGuests:Boolean? = null
    var allowExtraRequirements:Boolean? = null
    var allowBookingInProgress:Boolean? = null
}

open class ApiServiceResponse : IServiceResponse
{
    var description:String? = null
    var heading:String? = null
    var wasSuccessful:Boolean? = null
    var modelState:Object? = null
}

open class ScheduleDayData
{
    var date:String? = null
    var slots:ArrayList<SlotData> = ArrayList<SlotData>()
}

open class SlotData
{
    var start:String? = null
    var end:String? = null
    var status:SlotStatus? = null
    var bookingId:Int? = null
    var remindStart:Boolean? = null
    var remind30Mins:Boolean? = null
    var remind1Hour:Boolean? = null
    var remind6Hours:Boolean? = null
    var remind12Hours:Boolean? = null
    var remind1Day:Boolean? = null
    var remind1Week:Boolean? = null
    var billableAmount:BigDecimal? = null
    var bookedByName:String? = null
    var billableHours:Double? = null
    var slotLength:Double? = null
    var userData:GuestData? = null
    var extraRequirements:String? = null
}

enum class SlotStatus(val value:Int)
{
    @SerializedName("0") Available(0),
    @SerializedName("1") Closed(1),
    @SerializedName("2") Booked(2),
    @SerializedName("3") UserBooked(3),
    @SerializedName("4") GroupBooked(4),
    @SerializedName("5") ToBook(5),
}

open class GuestData
{
    var name:String? = null
    var emailAddress:String? = null
    var mobileNumber:String? = null
    var userCustomFields:ArrayList<UserCustomFieldData> = ArrayList<UserCustomFieldData>()
    var isAlreadyUser:Boolean? = null
    var systemUserId:Int? = null
}

open class UserCustomFieldData
{
    var id:UUID? = null
    var value:String? = null
    var name:String? = null
    var optional:Boolean? = null
}

open class FacilityData
{
    var facilityId:Int? = null
    var facilityGuid:String? = null
    var name:String? = null
    var description:String? = null
    var nextAvailable:String? = null
    var hasNextAvailable:Boolean? = null
    var rates:ArrayList<RatesItem> = ArrayList<RatesItem>()
    var themeColor:String? = null
    var bookingNotes:String? = null
    var leadTime:Int? = null
    var venueId:Int? = null
    var allowExtraRequirements:Boolean? = null
}

open class RatesItem
{
    var rate:BigDecimal? = null
    var minutes:Int? = null
}

Kotlin GetFacilitySchedule DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/GetFacilitySchedule HTTP/1.1 
Host: reservation.api.dev.86degrees.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"facilityId":0,"start":"0001-01-01T00:00:00.0000000","end":"0001-01-01T00:00:00.0000000","apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"schedule":[{"date":"String","slots":[{"start":"String","end":"String","status":0,"bookingId":0,"remindStart":false,"remind30Mins":false,"remind1Hour":false,"remind6Hours":false,"remind12Hours":false,"remind1Day":false,"remind1Week":false,"billableAmount":0,"bookedByName":"String","billableHours":0,"slotLength":0,"extraRequirements":"String"}]}],"bookAheadMaxDate":"String","openHour":0,"closeHour":0,"duration":0,"isCoordinator":false,"facilityTimeOffset":0,"venueName":"String","allowGuests":false,"allowExtraRequirements":false,"allowBookingInProgress":false,"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}