Learn how the Retrieval API data bundles organize response data.

Response data is organized into data bundles within each response document.

There are two category of data bundles:

  • RampID bundles: These bundles return RampIDs.
  • Metadata bundles: These bundles return information related to the request or the processing of the request for calls made to the Match endpoint.

When developing your app to call the Retrieval API, it is important to understand the following:

  • The API only returns true Boolean values. Missing Boolean values are implied to be false. This means that bundles containing only false values will also not be returned. Client code should always check for the existence of bundles before reading their values. You should code your applications to deal with either the presence or absence of each requested bundle on any given request.