Using the Help

This online help provides three basic kinds of information about the JSON APIs: Guides, API references, and workflow diagrams.

Each functional area of managing travel with the JSON APIs has a Guide. Guides cover basic concepts and usage information. In addition to the functional guide, any API with a lengthy request and response has its own guide as well. Most API guides include layout diagrams illustrating the basic structure of that API's request and response.

For every API, an API Reference provides object-level details including supported formats and values. API references always include:

  • method and endpoint
  • any query parameters
  • reference tables for the request and response
  • request and response examples

Many of the JSON APIs are linked together in workflows. The workflow diagrams provide a high-level overview of processes such as booking and ticketing, and help you decide which workflow to implement in various scenarios.

Each page for a Guide, API Reference, and Workflow uses a standard format to present the same types of information consistently across the help.

Notes like this are called out with a green sidebar.

... and ...

Information that can help prevent an unexpected result or error message is called out with a red sidebar.

If you've checked the guide and the API reference for an API and/or its functional area without finding what you need, try a search at the top of any page within the JSON APIs documentation frame. (The search bar at the top of the page searches across all Developer Experience sites.)

All objects are documented in the help. For technical details enter the exact object name. For terms, leave spaces and use quotation marks as needed.