Reservation Station API

<back to all web services

GetVenueReservations

Requires Authentication
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


@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 VenueReservationData(IBookingData):
    day_end: int = 0
    day_start: int = 0
    booking_id: int = 0
    slot_length: int = 0
    facility_id: int = 0
    facility_time_offset: int = 0
    cancellation_lead_time: int = 0
    end: Optional[str] = None
    start: Optional[str] = None
    user_name: Optional[str] = None
    facility_name: Optional[str] = None
    facility_colour: Optional[str] = None
    reservation_status: Optional[str] = None
    finished: bool = False
    billable_hours: float = 0.0
    billed_amount: Decimal = decimal.Decimal(0)
    user_data: Optional[GuestData] = None
    allow_extra_requirements: bool = False
    extra_requirements: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetVenueReservationsResponse(ApiServiceResponse):
    reservations: Optional[List[VenueReservationData]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetVenueReservations(ApiServiceRequest):
    venue_id: int = 0

Python GetVenueReservations DTOs

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

HTTP + CSV

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

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

{"venueId":0,"apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"reservations":[{}],"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}