Service facts

• Name: AvinorReferenceDataRequestService

• Operations:
  

• REST service, operations accessed using HTTPS GET

• Service security: Decided by implementation

• Standard return codes are described here: Service Return Codes

Introduction

Overview

This service description defines one service with a set of operations to request reference data. All data elements are defined by the Airport Data Dictionary.

The service is primarily designed to meet the need of airport partners, but availability is the decision of the service provider.

There are a set of use cases that can be realized using the operations and data available, for example:

• • Get .....
  • Get ....

All operations use a similar set of parameters to select the relevant reference data. The actual parameters used and the data return is specific for each operation.

It is typically considered enough to refresh reference data once a day.

Implementation considerations

Any implementation of this service MUST use the XSD files provided here: XSDs

It is however up to the service provider which data elements to support, and how much data to return. To enable this most elements are optional. The reason for a service provider to not support all elements might be business rules related to data distribution, that it doesn't have the information, or that it wants to provide information in other (more restricted) ways.

Any service provider should make available documentation about the actual implementation, including:

• • the address of the service.
  • any limitations in the implementation.
  • recommended and allowed polling intervals.

Purpose of this service description

This service description has the following purpose:

• • • Describe of service in enough detail for a service provider to implement it.
    • Describe the service so that a client (of this service) developer can use it.
    • Make available the XSD files necessary to implement and use the service.
    • Make it possible for relevant people at airports, airlines, handlers and other aviation partners to understand the available functionality and then to decide if to implement/use it or not.

Intended readership

• • IT architects
  • Developers
  • Business architects
  • Interested parties in the aviation community

Service overview

Service operations

Data entities

XSDs