The VAAC London QVA Products API supplies spatial polygon data in response to tailored API requests.
Data is provided under the remit of the International Civil Aviation Organisation (ICAO) and can be used to support activities related to aviation. Specifically, it enables aviation end users operate more effectively in airspaces affected by volcanic eruptions emanating from Iceland.
This API includes forecast polygons of volcanic ash, with payloads in XML format as per the IWXXM schema. Data consists of sets of polygons that represent the ash concentration when it exceeds each of the four following four thresholds in mg/m3: ≥0.2, ≥2.0, ≥5.0 and ≥10.0, where the ash plume is present in the atmospheric layer between FL000 and FL600. This collection has one dataset.
Operations
The VAAC London QVA Products API provides meteorological forecasts as XML files.
It also provides end users the ability to request metadata about the meteorological forecast included in the forecasts, returning a response in .JSON format.
Synchronous: Transactions are synchronous.
TI Protocol Method: HTTP GET
Precondition: Consumers must be authenticated and authorised via the Met Office API Management (APIM) Developer portal.
Processing consideration: The service shall provide only the latest available data.
Endpoints
This endpoint is the root for the VAAC London QVA Products API.
Querying this endpoint returns static metadata in JSON format with this information:
- Service description and keywords
- Provider name and contact details
- List of endpoints accessible via the Service
Querying this OpenAPI endpoint returns static metadata in JSON format with this information:
- API definition
- EDR specifications
Querying this endpoint returns static metadata in JSON format providing information about the OGC conformance classes implemented by the API.
This endpoint returns metadata in JSON format about the "qvaci_iwxxm" collections that is available to be queried. Metadata includes:
- Collection "id", "title" and "description"
- Geospatial information
- Forecast intervals (timesteps)
- Vertical atmospheric slices
- a list of "volcano_id" and associated metadata
Get information about the "qva_iwxxm" {collectionId}. It is the ‘source of truth’ to check which data has been generated and is ready to download. This is the endpoint that you can query to find out the applicable "volcano_id" for which forecast data is available. You can then use "volcano_id" to build your API request.
Response is a JSON file.
Get information about all the available locations data (displayed as ‘volcano_id’) in the "qvaci_iwxxm" {collectionId}.
This is also the endpoint that you can query to find out the applicable volcano for which forecast data is available. If forecasts are available for multiple volcanic eruptions, then multiple "volcano_id" may be listed.
Response is a JSON file.
This is the endpoint you query to retrieve the volcanic ash forecast in the "qvaci_iwxxm" {collectionId} for a specific "volcano_id"/{locationId}.
Example URL for requesting data in the "qvaci_iwxxm" collection for "volcano_id" 372070 (Hekla in Iceland): https://gateway.api-management.metoffice.cloud/vaac-london-qva-products/1.0/collections/qvaci_iwxxm/locations/372070
A successful request for data will return a “302 Found” response code with a redirect link in the Location header of the response, which you can use to download the requested dataset. The link is valid for one hour.
Response is in XML format. When following the Redirected URL, you will get a 200 response and the requested data, which you can save as an .xml file in your systems.
Service Interface Binding
The Service Interface Binding is SWIM Yellow Profile Compliant, using WS Light enabling HTTP GET requests and associated responses.
- The Service shall return a .JSON response for metadata requests:
- OpenAPI:
- / gets the EDR root data entrypoint
- /api gets the EDR spec for exposed endpoints
- /conformance gets the conformance data for the API
- Collections data:
- /collections gets the end point that contains information about all the collections available
- /collections/{collectionId} gets the end point that contains information about an individual collection {collectionId}
- Location data: /collections/{collectionId}/locations gets the end point that contains information about the volcanoes for which ash forecast data is available in an individual collection {collectionId}
- OpenAPI:
- Request for meteorological forecast data shall return a response as a 302 URL redirect to the payload, either in netCDF or IWXXM format:
- Ash concentration forecast for a specific Volcano (locationId}: /collections/{collectionId}/locations/{locationId} gets the end point for forecast data for a specific volcano (locationId} contained in an individual collection {collectionId}
Network Interface Binding
The Service implementation conforms with IPV4_SECURE_UNICAST as part of SWIM Yellow Profile requirements.