Reservation Station API

<back to all web services

GetFacilitySchedule

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceRequest(IServiceRequest, IHasApiKey, IHasDeviceInfo):
    # @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    api_key: Optional[str] = None
    """
    The API Key required for authentication
    """


    # @ApiMember(DataType="double", Description="Latitude of the user making this request")
    latitude: float = 0.0
    """
    Latitude of the user making this request
    """


    # @ApiMember(DataType="double", Description="Longitude of the user making this request")
    longitude: float = 0.0
    """
    Longitude of the user making this request
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceResponse(IServiceResponse):
    description: Optional[str] = None
    heading: Optional[str] = None
    was_successful: bool = False
    model_state: Optional[Object] = None


class SlotStatus(IntEnum):
    AVAILABLE = 0
    CLOSED = 1
    BOOKED = 2
    USER_BOOKED = 3
    GROUP_BOOKED = 4
    TO_BOOK = 5


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserCustomFieldData:
    id: Optional[str] = None
    value: Optional[str] = None
    name: Optional[str] = None
    optional: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GuestData:
    name: Optional[str] = None
    email_address: Optional[str] = None
    mobile_number: Optional[str] = None
    user_custom_fields: Optional[List[UserCustomFieldData]] = None
    is_already_user: bool = False
    system_user_id: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SlotData:
    start: Optional[str] = None
    end: Optional[str] = None
    status: Optional[SlotStatus] = None
    booking_id: int = 0
    remind_start: bool = False
    remind30_mins: bool = False
    remind1_hour: bool = False
    remind6_hours: bool = False
    remind12_hours: bool = False
    remind1_day: bool = False
    remind1_week: bool = False
    billable_amount: Decimal = decimal.Decimal(0)
    booked_by_name: Optional[str] = None
    billable_hours: float = 0.0
    slot_length: float = 0.0
    user_data: Optional[GuestData] = None
    extra_requirements: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduleDayData:
    date: Optional[str] = None
    slots: Optional[List[SlotData]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RatesItem:
    rate: Decimal = decimal.Decimal(0)
    minutes: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FacilityData:
    facility_id: int = 0
    facility_guid: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None
    next_available: Optional[str] = None
    has_next_available: bool = False
    rates: Optional[List[RatesItem]] = None
    theme_color: Optional[str] = None
    booking_notes: Optional[str] = None
    lead_time: int = 0
    venue_id: int = 0
    allow_extra_requirements: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetFacilityScheduleResponse(ApiServiceResponse):
    schedule: Optional[List[ScheduleDayData]] = None
    book_ahead_max_date: Optional[str] = None
    open_hour: int = 0
    close_hour: int = 0
    duration: int = 0
    is_coordinator: bool = False
    facility_time_offset: int = 0
    facility: Optional[FacilityData] = None
    venue_name: Optional[str] = None
    allow_guests: bool = False
    allow_extra_requirements: bool = False
    allow_booking_in_progress: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetFacilitySchedule(ApiServiceRequest):
    facility_id: int = 0
    start: datetime.datetime = datetime.datetime(1, 1, 1)
    end: datetime.datetime = datetime.datetime(1, 1, 1)

Python GetFacilitySchedule DTOs

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

{
	facilityId: 0,
	start: 0001-01-01,
	end: 0001-01-01,
	apiKey: String,
	latitude: 0,
	longitude: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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: {}
}