Adding and Deleting Passive Segments

An existing Universal Record data can be modified to add a new passive segment or delete an existing segment. Because passive segment data is external, and cannot be modified through Universal API, passive segment data can only be added or deleted through Universal API.

Important! Deleting a passive segment in Universal API does not cancel the segment; deleting merely removes the information from the Universal Record. The supplier or the supplier's system must be contacted directly to cancel the actual segment that is represented as a passive segment in Universal API.

Alternatively, passive segments can be created or canceled through a PNR rather than the Universal Record.

Request

UniversalRecordModifyReq/UniversalModifyCmd in the UniversalRecordModifyService is used to modify Universal Record data for traveler information, general UR information, and segment-related data.

Adding, deleting, or updating existing segment data is performed through the following child elements:

PassiveAdd, which adds a passive segment to an existing Universal Record.
PassiveDelete, which removes the passive segment from the Universal Record.

Passive Segments (particularly Air, Car, Hotel and Surface) are included for Continuity Check within the Universal Record. A Continuity Error is returned if the Passive Segments that are sold have discontinuity with each other or existing segments and the ContinuityCheckOverrideRemark attribute is not sent in the Universal API request. Air Passive Segments are considered at par with active air segments, Hotel Passives with active hotel, and so on for the continuity validation. ARNK segments are added for Air Passives and are similar to active air segments. If the override remark is added, any continuity breaks are returned as warnings.

Passive Remarks can be added when a Passive Segment is added. When a request is sent to the Apollo (1V) provider only, special characters are included in the Passive Remark. ^(caret), &(ampersand), and <(Less Than) are removed because they return an error or need special handling.

Note: No other providers support this enhancement. All other providers continue to remove special characters in Passive Remarks when a passive reservation is created or modified.

Universal API does not perform any validation of special characters, and if the provider returns an error for any special character, it is include in the Universal API response.

If multiple modifications are made to a Universal Record, an instance of UniversalModifyCmd must be associated with each change request.

Adding Passive Segments

The PassiveAdd child of UniversalModifyCmd is used to add a passive segment to an existing Universal Record.

Travelport Universal API supports adding Associated Remarks to Passive segments for Air, Hotel, Vehicle, Tour, Cruise and other segments that are booked outside of Travelport Universal API, via the AssociatedRemark child element added to UniversalRecordModifyReq/UniversalModifyCmd/PassiveAdd/. This update is not backwards compatible.

The required ReservationLocatorCode attribute identifies the PNR to which the travel segment is added. This ReservationLocatorCode is assigned by the provider and is distinct from the identifier for the UniversalRecord that is issued by Universal API.

The client must add the supplier's code and record locator in SupplierLocatorand an associated SegmentRef. If an associated segment is not referenced, an error is returned: "Segment Reference in SupplierLocator is mandatory by the requested provider."

The TravelOrder attribute in PassiveAdd/PassiveSegment is returned against the Passive Segments to indicate their position within the UniversalRecord. All passive Segment types are ordered within the itinerary by Start Date and then End Date, when applicable. Primarily, End Date is considered for Air and Rail segments. For others, currently, only the Start Date is considered. If the dates match, a priority is used at the UR level for sorting the segments:

PRIORITY_AIR = 0; // highest
PRIORITY_RAIL = 1;
PRIORITY_ARNK = 2;
PRIORITY_VEHICLE = 3;
PRIORITY_HOTEL = 4;
PRIORITY_PASSIVE = 5;

The priority of passives segments is the same as the active counterparts. Within the same date, the passive segments of other segment types, such as Tour or Limousine, do not have a specific priority order hierarchy and can be placed in no particular order after considering the Date criteria.

Deleting Passive Segments

The PassiveDelete child of UniversalModifyCmd is used to delete a passive segment from an existing Universal Record.

The following data is required to delete a vehicle segment or segment data:

The required ReservationLocatorCode attribute identifies the PNR with the associated vehicle segments.

The Element is set to 'PassiveSegment' to delete the entire segment.

A Key from the PNR is required to uniquely identify the specific item to be deleted based on the unique key assigned to that item.

Exceptions

Worldspan