Custom Rule Details API Reference

Get

book/customrule/customrules/?PCCClosed Pseudo city code. A travel provider's identification code for the JSON APIs, provisioned from Travelport. Used to determine access and other settings in the JSON APIs for your company.={PCC}?RuleRecordName={NAME}

Base path:

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

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

Related Content: Custom Rules Guide

Send the Custom Rule Details request to retrieve details about a specific custom rule. This standalone request can be sent as part of a workbench session or without a workbench.

Custom rules are created in a rules bookingClosed A confirmed reservation with the carrier. A held booking is a reservation that has not yet been ticketed. The terms booking and reservation are interchangeable. engine used by your agency. See Custom Rules for details.

Request

Also see Authorization and Common Headers.

Query Parameters

Parameter Description Required/Optional

PCC

 The PCC associated with the rule to retrieve.

Required

RuleRecordName

The name of the rule to retrieve. You can send a Custom Rule List request to return a list of all rules associated with a specific PCC.

Required

Request Body

There is no message payload.

Response

The response returns details of the requested rule.

Object

Description

CustomRuleResponse

Top level object.

Includes CustomRule object.

CustomRule

Top level object. Includes the following key value pair:

id: Short ID for CustomRule.

Includes Identifier, PseudoCItyCode, and RuleRecord objects.

Identifier

System-generated identifier for the response:

authority: Source of information.

value: Unique system-generated identifierClosed In the JSON APIs, a unique identifier for specific, unique data, such as an entire response or an offer, product, or brand in a response. These identifiers must often be sent in subsequent requests to refer to a previous response, offer, product, etc. Usually returned in Identifier/value for the referenced object. Example format: 3cecf1be-0b21-4881-8f33-ae11c8d7b708. See the JSON APIs Guide..

PseudoCItyCode

PCC sent in the request; the rule returned is specific to this PCC.

RuleRecord

Rule details. Includes RuleRecordName and RuleText objects.

Key value pair:

sequence: Sequence of this rule. Send this value when deleting a rule from a booking.

RuleRecordName

String. Name of this custom rule. Send this value when adding a rule to a booking.

RuleText

Array of rule strings. Includes StringText object.

Key value pair:

sequence: Sequence of this string.

StringText

String. The text of the rule as configured in the booking file management tool (see the Custom Rules for details).

Example Request

Send the PCC and the name of the rule to return details for. 

https://api.travelport.com/11/air/book/customrule/customrules/?PCC=X9Z&RuleRecordName=CORP

Example Response

The response returns details of the requested rule.

{
    "CustomRuleResponse": {
        "CustomRule": {
            "@type": "CustomRule",
            "id": "customRule_1",
            "Identifier": {
                "value": "14947439-09b3-436a-bb7c-c86703f59167",
                "authority": "Travelport"
            },
            "PseudoCityCode": "DU7",
            "RuleRecord": [
                {
                    "@type": "RuleRecord",
                    "sequence": 1,
                    "RuleRecordName": "TKP",
                    "RuleText": [
                        {
                            "@type": "RuleText",
                            "sequence": 1,
                            "StringText": " IF EM ANDFOR FARE ANDNOT FINDCOR LIT/C/ AND OCCURS TIMES1-99 THEN SAY VERIFICAR ACUERDO DE INTERLINEA Y ANADIR ANTES EN LA TARIFA TMU"
                        },
                        {
                            "@type": "RuleText",
                            "sequence": 2,
                            "StringText": " IF EW ANDFOR F. AND LIT/S/ OR LIT/CK/ THEN SAY CASH OR CHEQUE FOP NOT ALLOWED IN F. ENTRY"
                        },
                        {
                            "@type": "RuleText",
                            "sequence": 3,
                            "StringText": " IF EW ANDFOR F. AND LIT/CC/ THEN SAY NO SE PERMITE PAGO CON TARJETAS DE CREDITO"
                        }
                    ]
                }
            ]
        }
    }
}