Retrieve Programme API Documentation

The Retrieve Programme endpoint enables a Partner to retrieve programmes supported by the Avios currency. The endpoint returns programme information as part of successful response.

The objectives of this service are:

• To retrieve the complete list of programmes supported by Avios currency.
• To retrieve a programme by specifying the programme identifier.
• To retrieve the list of programmes which belongs to provided location identifier.
• To retrieve the list of programmes by specifying a membership identifier, e.g. return the list of programmes associated with a membership.

For Partners attempting to simply return the details of one programme, the only URI parameter that is required is the programme-identifier.

For Partners that want all programmes associated with a certain area code, they can include the specific area code in the endpoint.

Partners that want to return a list of programmes associated with a certain member, they simply include the membership-identifier in the endpoint.

Business Context

A summary of the process flow is as follows:

• The Partner calls the Retrieve Membership endpoint to retrieve membership details.
• The details of the membership are returned along with additional links to retrieve associated programme information.
• Partner clicks the provided link to retrieve programme information.
• Retrieve Programme endpoint is called and the programme details are returned.

Important Technical Notes

• All enumerated values must be upper case.

Pre-conditions

• The partner must have a valid API key to access the Retrieve Programme API

Post-conditions

Success outcome: HTTP status code 200 is returned along with details of the programme.

Error outcome: An error is returned.

Service Details

URI Parameters

Making a call to the API using only programme-identifier:

'GET https://api.avios.com/{version}/programmes/{programme-identifier}?api_key={api_key}'

Example

https://api.avios.com/v1/programmes/ATRP?api_key=abcdefabcdefabcdefabcdef

Making a call to the API using location-identifier to narrow the search:

'GET https://api.avios.com/{version}/programmes?location-identifier={location-identifier}&api_key={api_key}'

Example

https://api.avios.com/test/v1/programmes?location-identifier=GB&api_key=Abcdefabcdefabcdefabcdef

Making a call to the API using only the membership-identifier:

'GET https://api.avios.com/{version}/programmes?membership-identifier={membership-identifier}&api_key={api_key}'

Example

https://api.avios.com/v1/programmes?membership-identifier=3081470000000000&api_key=Abcdefabcdefabcdefabcdef

Request Headers

Response Message Elements

The following are examples of successful responses from the Retrieve Programme API:

{
  "name": "AVIOS AGL",
  "_links": {
    "self": {
      "href": "https://api.avios.com/test/v1/programmes/ATRP"
...Show more

{
  "size": "2",
  "programmes": [
    {
      "identifier": "ATRP",
...Show more

A response from the API containing only a singular programme will have the following response elements:

And for responses containing multiple programmes:

Exception Message Elements

The following is an example of an unsuccessful response from the Retrieve Programme API:

{
  "code": "PROGRAMME_NOT_FOUND",
  "businessMessage": "Programme Not Found",
  "developerMessage": "Programme Not Found",
  "developerLink": "https://developer.iagloyalty.com/docs"
...Show more

Error Codes