API - Planyo Web Services - make_reservation

Planyo » Pomoc » API » make_reservation

make_reservation (version 0.2)

Description:

Enters a new reservation into the system. The ID of the new reservation is available in 'reservation_id' in case of success.

Input:

resource_id int required
ID of the resource
start_time DateTime required
Beginning of rental
end_time DateTime required
End of rental
quantity int required
Number of units
wants_share SharingMode optional
Set the desired sharing mode (used only when sharing is possible)
rental_prop_xyz string required
Resource-specific additional fields (defined in the admin panel in: Resource settings / Additional reservation data). E.g. if you define additional reservation property 'number of children', this should be passed as rental_prop_number_of_children (where '_' replaces all space characters)
email string required
User's email address
first_name string required
User's first name
last_name string required
User's last name
address string required
User's address
city string required
User's city
zip string required
Zip or postal code
state string required
State or province
country string required
Two-letter country code (ISO 3166-1 alpha-2)
phone_prefix string required
Phone country code (e.g. 1 for USA and Canada)
phone_number string required
Phone number (excluding country code)
mobile_prefix string required
Mobile country code (e.g. 1 for USA and Canada)
mobile_number string required
Mobile number (excluding country code)
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:

reservation_id int
Returns the ID of the newly created reservation (if successful).
user_text string
Text to be displayed to the user with the status of their reservation
status ReservationStatus
Status of the new booking