rv_create_itinerary

rv_create_itinerary

Description

Creates an itinerary and links it to the specified reservation. Returns boolean true if successful; boolean false if not.

Access

Writes new data, master access not required, available to internal users only.

Parameters

Number	Name	O/R	Usage
1	Auth	Required	Authentication structure.*
2	Reservation ID	Required	“Id” of the reservation to return detail for. Case sensitive.
3	Items	Required	An array of itinerary items to be created as part of the reservation. The array must consist of either a list of further arrays or a list of structures containing the relevant fields – see table below. For Rate Group array structure, see table below.
4	Allow overbooking	Optional	If this optional value is not empty then an overbooking will be allowed if the user has access to process it.

*See call structure explanation.

3. Item array structures:

Array key	Structure key	Version	Description
O	accommodation_type		“Id” of the accommodation type to book stock for.
1	date_arrive		Date from which the accommodation would be required.
2	date_depart		Date to which the accommodation would be required.
3	rate_groups		Array consisting of the rate groups and quantities thereof. This includes the unit (ie. rooms) quantity. (see table below)
4	override		Override value. This optional value is dependent on the level and type of override allowed per rate. If left empty, or false, no override takes place.
5	rate_type		This optional value allows the rate type of the itinerary to be overridden. If left empty, or false, the reservation rate type is used.
6	use_allocations	5.20.0+	If this optional value is not empty available allocations are used for the itinerary. If left empty, or false, allocations are not used.
7	guests		The “guests” field consists of an array for each group to be allocated to the itinerary. Guests should be comma delimited guest ids separated with a colon for each group.

3. Rate Group array structures:

Array key	Structure key	Description
O	rate_group_id	“Id” of the rate group
1	qty	Quantity for the rate group

Example

Request

{
    "method": "rv_create_itinerary",
    "params": [
        {
            "bridge_username":"username",
            "bridge_password":"password",
            "link_id":"4"
        },
        "WB677",
        [
            [
                "WB7",
                "2018-04-05",
                "2018-04-06",
                [
                    [
                        "RS1",
                        "1"
                    ],
                    [
                        "RS2",
                        "1"
                    ]
                ],
                "",
                "",
                ""
            ]
        ]
    ],
    "id": 1
}

Response

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

rv_create_itinerary

Description

Access

Parameters

Example

Keep up to date with us

Menu

Visit our website

ResRequest Modules