rv_get_room

rv_get_room

Description

Returns a list of checked in rooms with details on the reservation and guests.

Version

Available from version 5.30.0.

Access

Read-only, master access not required, available to internal users only.

Parameters

Number	Name	O/R	Version	Description
1	Auth	Required	5.20.0+	Authentication structure.*
2	Property	Required		Id of the property in which to search.
3	Accommodation	Optional		List of accommodation type ids to search. A single accommodation type id may be specified as a string and multiple accommodation type ids as an array. If not specified (left out, empty string or empty array) then all accommodation types will be searched.
4	Search	Optional		A string may be used to search simultaneously by room #/name, res #/name and guest name. The search criteria may use * or % as wildcard characters.

A more precise search can be conducted by using the below fields in the search structure:

Name	Type	Description
name	String	Search criteria for the room name
reservation_id	String	Search criteria for the reservation id
reservation_name	String	Search criteria for the reservation name
guest	String	Search criteria for the guest name
type	String	The search method to use which may be one of: ‘any’: This is the default method. Results will be included if any criteria match. Criteria are automatically surrounded with wildcards. ‘all’: Results will only be included if all criteria match. Criteria are not automatically surrounded with wildcards.

All search fields are optional when using the structure.

All searches are case-insensitive.

*See call structure explanation.

Response

An array of structures containing the following fields:

Name	Type	Description
rooms	Object[]	List of rooms (array of objects)

A room array object can consists of the following fields:

Name	Type	Usage
id	String	Unique identifier for room
name	String	Full name of room
accommodation_id	String	Unique identifier for the accommodation type
accommodation_name	String	Name of the accommodation type
group_id	String	Unique identifier for the room group
reservation_id	String	Unique identifier for the reservation
reservation_name	String	Name of the reservation
rate_type_id	String	Unique identifier for the rate type
rate_type_name	String	Name of the rate type
components	Object[]	List of components in the itinerary
guests	Object[]	List of guests in the room

Components array objects can consists of the following fields:

Name	Type	Description
id	String	Unique identifier for the component
code	String	Code of the component
name	String	Name of the component

Guests array objects can consists of the following fields:

Name	Type	Description
id	String	Unique identifier for the guest
name_last	String	Last name of the guest
name_first	String	First name of the guest

Example

Request

{
	"method": "rv_get_room",
	"params": [
		"{{username}}",
		"{{password}}",
		"{{principal}}",
		"{{property id}}",
		"{{accommodation id(s)}}",
		"{{search reservation / room / guest}}"
	],
	"id": null
}

Response

{
    "id": 1,
    "error": null,
    "result": "HEAD"
}

rv_get_room

Description

Version

Access

Parameters

Response

Example

Keep up to date with us

Menu

Visit our website

ResRequest Modules