Custom Rule Suspend/Reactivate API Reference

Suspend custom rules

PUT

Suspend all custom rules in the reservation: 

book/customrule/customrules/{workbenchID}/suspension

Suspend a specific custom rule in the reservation:

book/customrule/customrules/{workbenchID}/suspension?RuleRecordSequence={XYZ}

For {workbenchID} send the workbench identifier returned in ReservationResponse/Identifer/value in the workbench create response.

For {XYZ} send the custom rule identifier for the rule you want to suspend.

Base path:

Pre-production https://api.pp.travelport.net/11/air/

Production https://api.travelport.net/11/air/

Reactivate custom rules

PUT

Reactivate all custom rules in the reservation: 

book/customrule/customrules/{workbenchID}/reactivation

Reactivate a specific custom rule in the reservation:

book/customrule/customrules/{workbenchID}/reactivation?RuleRecordSequence={XYZ}

For {workbenchID} send the workbench identifier returned in ReservationResponse/Identifer/value in the workbench create response.

For {XYZ} send the custom rule identifier for the rule you want to reactivate.

Base path:

Pre-production https://api.pp.travelport.net/11/air/

Production https://api.travelport.net/11/air/

Related Content:Booking Guide, Custom Rules, Custom Rule List, Custom Rule Details

Custom rules can be added to a reservation when it is created or modified. Custom rules are validated when a reservation is created, modified, updated through an API, or updated through an agent desktop. This API allows you to suspend all custom rules or a specific custom rule from a reservation. A suspended custom rule is not deleted. It remains part of the reservation retrieve response.

This API also allows you to reactivate all suspended custom rules or a specific suspended custom rule for a reservation.

Send the suspend and reactivate request as part of a workbench session, either during the initial booking workflow after an offer is added, or a post-commit workbench for an existing reservation.

The PUT request must be followed at some point by a workbench commit.

Custom rules are created in a rules booking engine used by your agency. See Custom Booking Rules in the Booking Guide for details.

Note the following:

  • If you send a suspend request for a rule that is already suspended, the error message CUSTOM CHECK RULE {NAME} ALREADY SUSPENDED IN RESERVATION is returned.
  • If you send a reactivate request for a rule that is not suspended, the error message CUSTOM CHECK RULE {NAME} IS NOT SUSPENDED IN RESERVATION is returned.

Request

As part of the request requirements, also see Authentication and Common Flights API Headers.

Query Parameters

Parameter Description Required/Optional

RuleRecordSequence

Use in the PUT request to specify the sequence number of a single rule to suspend or reactivate in the booking. Supported value:

  • {sequence number}: Send up to three digits (001-999) to specify the rule record sequence of the rule to suspend or reactivate. You can send a reservation retrieve with detail view requested to see the rules attached to a booking.

Required to suspend or reactivate a specific rule

Request Body

There is no message payload.

Response

The POST response returns a standard system-generated identifier for the transaction. The DEL response does not return a payload.

Object

Description

CustomRuleResponse

Top level object.

Includes Result object.

Result

Returns messages about transaction.

Key value pair:

status: Status of transaction.

Example Request

This request has no message payload.

Suspend the custom rule that has a sequence value of 1: 

PUT https://api.travelport.net/11/air/book/customrules/{workBenchID}/suspension?RuleRecordSequence=1

Reactivate the custom rule that has a sequence value of 1: 

PUT https://api.travelport.net/11/air/book/customrules/{workBenchID}/reactivation?RuleRecordSequence=1

Example Response

The PUT response returns the status of the request.

{
 "CustomRuleResponse": {
  "Result": {
    "@type": "Result",
    "status": "Complete"
   }
  }
}