Capabilities metadata resource

This resource returns metadata for layers.

Method	URL format
`GET`	`https://{base_url}/weather/2.0/layer/{id}/metadata`

You can find more details on the applicable path parameter in the sections below. The base_url will be provided during the process of obtaining credentials.

Authorization

Each request is authenticated and requires a valid bearer token to be included in HTTP Authorization header:

Authorization: Bearer <token>

For more information about obtaining credentials, see the Identity and Access Management Developer Guide.

Path parameters

The table below documents the path parameters.

Parameter	Required	Description
`id`	Yes	ID of the layer. `1` - the Doppler radar layer. Shows current or historical precipitation based on actual radar images. Coverage is limited to available radar stations. `2` - Global precipitation layer. Shows current, historical, or future precipitation. Based on a precipitation model that uses radar, satellite imagery, climate models, and possibly other inputs. Images are more accurate than radar alone, and they cover locations where no radar is available, in addition to forecasting the future.

Response

On success, the response status is 200 OK and the response payload contains information for available tiles.

The response is in json format.

Truncated example:

{
  "id": 2,
  "layerDescriptors": [
    {
      "title": "Global precipitation forecast",
      "updated": "2022-04-12T12:00:00Z",
      "boundingBox": {
        "north": 77,
        "west": -180,
        "south": -77,
        "east": 180
      },
      "timestamps": [
        "2022-04-12T06:00:00Z",
        "2022-04-12T09:00:00Z",
        "..."
      ],
      "current": 72
    }
  ]
}

Attribute	Description
id	ID of the layer.
layerDescriptors	Array of available tiles.
title	Name of tile.
updated	UTC date and time when image data were last time updated.
boundingBox	Bounding box of tile.
timestamps	Array of available timestamps to obtain radar images for tile.
current	Timestamps array index which represent actual (current) image.

Response status 400 Bad Request is returned if 'id' doesn't match supported layer Ids.

{
  "Type": "Invalid Request",
  "Message": [
    "LayerId '5' is invalid. Only layer Ids '1,2' are allowed."
  ]
}