rv_request_cancel

rv_request_cancel

Description

Generates a reservation cancel request email and sends it to the supplier. Returns true if the cancellation request is successful.

Warning
Bookings are not cancelled electronically. This call generates a Cancel Email to the supplier.

Version

Available from version 6.14.11+.

Access

Writes new data, master access not required, user must have update access to the “Availability calendar” function.

Parameters

Number	Name	O/R	Version	Usage
1	Auth	Required	6.14.11+	Authentication structure.*
2	Reservation id	Required	6.14.11+	“Id” of the reservation to send the cancellation request for.
3	Reference	Optional	6.14.11+	Third party reference for the cancellation. If empty the voucher reference will be used. If the voucher reference is also empty then the reservation id will be used.
4	Reason	Optional	6.14.11+	The reason for the cancellation. If empty “No reason provided” will be used.
5	From	Optional	6.14.11+	Override the from email address. If empty the principal email will be used. If the principal email is also empty then “[email protected]” will be used.
6	To	Optional	6.14.11+	Additional email addresses to send copies to. This may take the form of an array, comma-delimited list or colon-delimited list.

*See call structure explanation.

Example

Request

{
    "method": "rv_request_cancel",
    "params": [
        {
            "bridge_username":"username",
            "bridge_password":"password",
            "link_id":"4"
        },
        "WB677",
        "Third party cancellation reference",
        "Cancellation reason",
        "",
        "[email protected], [email protected]"
    ],
    "id": 1
}

Response

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

rv_request_cancel

Description

Warning

Version

Access

Parameters

Example

Keep up to date with us

Menu

Visit our website

ResRequest Modules