Response View

The Response View API allows you to use a preformatted Sabre response view for a given REST API.

In detail: this suite of utility APIs allows you to use preformatted Sabre response views that have been modified to include or exclude certain response paths by default. These default views can be used by any Pseudo City Code (PCC). You can then pass the response view as a filter in the request of any REST API that accepts a view (e.g. Bargain Finder Max) to trim the response. See also: the Custom Response View API to create a custom response view.

Response views can be used with the following APIs: Advanced Calendar Search, Alternate Airport Shop, Alternate Date, Bargain Finder Max, InstaFlights Search.

API Information

Target Audience
Sabre Travel Network
Current Version
v1
Authentication
Sessionless Token
Methods/Endpoints
GET /v1/lists/utilities/views HTTP/1.1
GET /v1/lists/utilities/views/{view} HTTP/1.1

Ready to try the APIs?

Ready to get your hands dirty?

 Register Try the APIs

Ready to launch?

Ready to step up to the production level service? We're standing by to fit you for your spacesuit.

Request Production Key

Sample workflow

Use Sabre response views as a starting point to define your custom views

  1. Invoke the Response View Lookup API as a starting point to view a list of the default Sabre response views.
  2. Invoke the Response View Details Lookup API to view the detailed response path notation of the included and excluded elements for a given Sabre response view.
  3. Identify the response views you would like to mimic or expand upon and create new custom response view definitions using the Create Custom Response View API.
  4. Invoke the applicable REST API for which the include/exclude response paths apply (e.g. Bargain Finder Max) and pass the new custom response view definition as a filter in the request, e.g., view=NOWARNINGS to format the response.

Response View Lookup

The Response View Lookup API returns a list of Sabre response views.

HTTP method and endpoint

GET /v1/lists/utilities/views

Request

This request does not have any variations or parameters. The URI requests a list of Sabre response views.

Response

Views

array

Repeats associated Sabre response view information:

  • View, string
  • Links, array
View

string

The Sabre response view

Sample values:

  • IF_ITIN_TOTAL_PRICE – excludes numerous response paths for the InstaFlights Search API
  • BFM_ITIN_TOTAL_PRICE – excludes numerous response paths for the Bargain Finder Max API

See also: the Response View Details Lookup to return the detailed response path notation of the included and excluded elements for a given Sabre response view.

Links

array

Contains links for each Sabre response view:

  • view, object
view

object

Returns a URL for each Sabre response view

Overall response links

Links

array

self

object

Returns the URL of the request that generated the response

linkTemplate

object

Formats a Response View Lookup API request

Example: request and response

This example demonstrates a request to return a list of Sabre response views.

GET https://api.sabre.com/v1/lists/utilities/views
{
    "Views": [{
        "View": "BFM_ITIN_TOTAL_PRICE",
        "Links": [{
            "rel": "view",
            "href": "https://api.sabre.com/v1/lists/utilities/views/BFM_ITIN_TOTAL_PRICE"
        }]
    }, {
        "View": "BFM_ITIN_BASE_TAX_TOTAL_PRICE",
        "Links": [{
            "rel": "view",
            "href": "https://api.sabre.com/v1/lists/utilities/views/BFM_ITIN_BASE_TAX_TOTAL_PRICE"
        }]
    }, {
        "View": "IF_ITIN_TOTAL_PRICE",
        "Links": [{
            "rel": "view",
            "href": "https://api.sabre.com/v1/lists/utilities/views/IF_ITIN_TOTAL_PRICE"
        }]
    }, {
        "View": "IF_ITIN_BASE_TAX_TOTAL_PRICE",
        "Links": [{
            "rel": "view",
            "href": "https://api.sabre.com/v1/lists/utilities/views/IF_ITIN_BASE_TAX_TOTAL_PRICE"
        }]
    }],
    "Links": [{
        "rel": "self",
        "href": "https://api.sabre.com/v1/lists/utilities/views"
    }, {
        "rel": "linkTemplate",
        "href": "https://api.sabre.com/v1/lists/utilities/views"
    }]
}

Errors

A general HTTP status code is always returned. For information about the error response format, see the: Sabre APIs: common errors page.

A client should verify whether a request was successful by writing code to the following:

200 OK

The request was successful.

404 NOT_FOUND

No results were found

The service cannot find data to fulfill the parameters in the request.

Response View Details Lookup

The Response View Details Lookup API returns the detailed response path notation of the included and excluded elements for a given Sabre response view.

HTTP method and endpoint

GET /v1/lists/utilities/views/{view}

Request

This request has a URI variable. Any valid Sabre view can be substituted for {view}. See also: the Response View Lookup to return a list of Sabre response views.

Response

Views

object

The Sabre response view definition:

  • Name, string
  • Includes, array
  • Excludes, array
Name

string

The Sabre response view name

Sample value: BFM_ITIN_TOTAL_PRICE

See also: the Response View Lookup to return a list of Sabre response views.

Includes

array

The JSON path notation of the included element

Excludes

array

The JSON path notation of the excluded element

Overall response links

Links

array

self

object

Returns the URL of the request that generated the response

linkTemplate

object

Formats a Response View Details Lookup API request, with a placeholder for a Sabre response view

Example: request and response

This example demonstrates a request to return the detailed response path for a given Sabre response view.

https://api.sabre.com/v1/lists/utilities/views/BFM_ITIN_TOTAL_PRICE
{
    "View": {
        "Name": "BFM_ITIN_TOTAL_PRICE",
        "Excludes": ["OTA_AirLowFareSearchRS.Warnings", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItinerary.DirectionInd", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItinerary.OriginDestinationOptions.OriginDestinationOption.FlightSegment.ResBookDesigCode", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItinerary.OriginDestinationOptions.OriginDestinationOption.FlightSegment.ElapsedTime", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItinerary.OriginDestinationOptions.OriginDestinationOption.FlightSegment.OperatingAirline", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItinerary.OriginDestinationOptions.OriginDestinationOption.FlightSegment.Equipment", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItinerary.OriginDestinationOptions.OriginDestinationOption.FlightSegment.MarriageGrp", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItinerary.OriginDestinationOptions.OriginDestinationOption.FlightSegment.DepartureTimeZone", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItinerary.OriginDestinationOptions.OriginDestinationOption.FlightSegment.ArrivalTimeZone", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItinerary.OriginDestinationOptions.OriginDestinationOption.FlightSegment.OnTimePerformance", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItinerary.OriginDestinationOptions.OriginDestinationOption.FlightSegment.TPA_Extensions", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItineraryPricingInfo.PricingSource", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItineraryPricingInfo.PricingSubSource", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItineraryPricingInfo.LastTicketDate", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItineraryPricingInfo.LastTicketDate", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItineraryPricingInfo.FareConstruction", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItineraryPricingInfo.PTC_FareBreakdowns", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItineraryPricingInfo.FareInfos", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItineraryPricingInfo.TPA_Extensions", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.TicketingInfo", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.TPA_Extensions", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItineraryPricingInfo.ItinTotalFare.BaseFare", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItineraryPricingInfo.ItinTotalFare.EquivFare", "OTA_AirLowFareSearchRS.PricedItineraries.PricedItinerary.AirItineraryPricingInfo.ItinTotalFare.Taxes"]
    },
    "Links": [{
        "rel": "self",
        "href": "https://api.sabre.com/v1/lists/utilities/views/BFM_ITIN_TOTAL_PRICE"
    }, {
        "rel": "linkTemplate",
        "href": "http://api.sabre.com:443/cto-darwin-raf/v1/lists/utilities/views/<view>"
    }]
}

Errors

A general HTTP status code is always returned. For information about the error response format, see the: Sabre APIs: common errors page.

A client should verify whether a request was successful by writing code to the following:

404 NOT_FOUND

No view named '{view}' is defined

The specified '{view}' does not exist.

Docs Navigation