Method

rxc-rez-get

Description

This method will return reservation information for the business logged in. It will return one reservation if a rez_id is passed or return multiple based on search criteria.

Parameters

Name Input Value Type Description
rez_id Integer (Optional) This is the unique identifier of the reservation we want to return. If not passed then there is potential for multiple reservations to be returned.
open_date Timestamp (Optional) This is the start date we are using to find any reservation with a check out date greater than this date. Only used if Rez_ID is not passed in.
close_date Timestamp (Optional) This is the end date we are using to find any reservation with a check in date less than this date. Only used if Rez_ID is not passed in.
withminimal Integer (Optional) This is a flag that specifies if we only minimal reservation information to be returned. This is useful for building a property management grid or who's here report.
withdetails Integer (Optional) This is a flag that specifies if we want reservation details to be returned with the reservations being returned.
withinvoices Integer (Optional) This is a flag that specifies if we want invoices to be returned with the reservations being returned.
withpayments Integer (Optional) This is a flag that specifies if we want payments to be returned with the reservations being returned.
display Enumeration (Optional) If specified, the result is filtered. Allowed options: ALL, CHECKEDIN, CHECKINUPCOMING, DUETOCHECKIN, DUETOCHECKOUT, CANCELLED, NOSHOW, CHECKEDOUT, CONFIRMED, CHECKINGOUT, PENCILIN, REZROBOTPENDING
type_id Integer (Optional) If specified, search criteria specific to the passed in unit type ID.
rez_number Integer (Optional) If specified, search criteria specific to the passed in rez number.
client_name String (Optional) If specified, search criteria specific to the passed in client name.
phone_number String (Optional) If specified, search criteria specific to the passed in client's phone number.
made_by Integer (Optional) If specified, search criteria specific to the passed in booking source.
cancel_type Integer (Optional) If specified, search criteria specific to the passed in cancellation type.
business_code Integer (Optional) Business Code of the business we are retrieving theme data for. If neither business_id or business_code are specified, the user's session is used to select business.
operation_business_id Integer (Optional) Business ID of the operation we are retrieving theme data for. If operation_business_id is not specified, the user's session is used to select operation business.
member_id Integer (Optional) Member ID of the client who made the reservation. If no member is specified then this will not be used as criteria to return reservations.
start_row Integer This is the start row we want to return. This is used to filter the number of records being returned.
end_row Integer This is the end row we want to return. This is used to filter the number of records being returned.
order_by Integer (Optional) This will tell the procedure how to order the data. 1=open_date, 2=create_time, 3=create_time desc.
format enumeration (optional) Set this value to "xml" for XML raw formatted output, "xml-clean" for XML tidy formatted output or "json" for JSON formatted output. If not passed, "xml" is used as a default

XML Encoded Request

URL Encoded Request





Result