rv_get_reservation

rv_get_reservation

Description

Used to look up one or more reservations.

Returns a list of reservation detail structures containing “id”, “name”, “arrive_date”, “depart_date”, “status”, “provisional_expiry_date”, “rate_type”, “agent”, “origin”, “contact”, “source”. Only reservations linked to the agent the API user was setup for, will be returned.

Access

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

Parameters

Number	Name	O/R	Usage
1	Auth	Required	Authentication structure.*
2	Reservation ID	Optional	“Id” of the reservation to return detail for. Case sensitive.
3	Reservation Name	Optional	Allows a search on reservation name. May use * or % as wildcard characters.
4	Start date	Optional	Date range start
5	End date	Optional	Date range end
6	Reservation Status	Optional	“Id” of the reservation status as looked up by rf_get_reservation_status.
7	Agent ID	Optional	“Id” of the agent, as looked up by pr_get_contact.
8	Contact ID	Optional	“Id” of the contact, as looked up by pr_get_contact.

*See call structure explanation.

Example

Request

{
    "method": "rv_get_reservation",
    "params": [
        {
            "bridge_username":"username",
            "bridge_password":"password",
            "link_id":"4"
        },
        "WB253",
        "",
        "",
        "",
        "",
        "",
        ""
    ],
    "id": 1
}

Response

{
    "id": 1,
    "error": null,
    "result": [
        {
            "id": "WB253",
            "name": "Mr John Smith",
            "arrive_date": "2018-12-01",
            "depart_date": "2018-12-08",
            "status": "20",
            "provisional_expiry_date": "2018-11-12",
            "rate_type": "WB5",
            "agent": "WB100",
            "origin": "",
            "contact": "WB101",
            "source": "RS100"
        }
    ]
}

rv_get_reservation

Description

Access

Parameters

Example

Keep up to date with us

Menu

Visit our website

ResRequest Modules