API - Planyo Web Services - list_reservations

Planyo » Pomoc » API » list_reservations

list_reservations (version 0.2)

Description:

Lists all reservations that either start within given time period or that were entered into the system within given time period (when list_by_creation_date is true)

Input:

start_time DateTime required

Start of time period

end_time DateTime required

End of time period

resource_id int optional

Optionally you can only list reservations for a single resource by specifying its ID here

list_by_creation_date bool required

If true, this function returns reservations created between given start and end time. If fals, the function returns reservations that begin between given start and end times.

sort string optional

Optional sort field. One of: user, user_id, email, phone, resource_id, resource, reservation_id, duration

version float optional

you can optionally specify the version of the API that you're using. Use the value of latest or simply skip this parameter to use the latest API version. The latest version is: 0.2

language string optional

by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned

api_key string required

your API key - Click here to get your key

Output:

results array

Array whose items are named arrays with the following keys: reservation_id, start_time, end_time, user_notes, admin_notes, custom_color, night_reservation, first_name, last_name, login, user_id, email, phone, phone_country_code, resource_id, name (resource name)