Release Notes REST API

This namespace describes endpoints and data types for release notes operations.

List Release Notes

Get all release notes linked to a release.

Endpoint	/releases/{id}/notes
HTTP Methods	GET
Request Content Type	application/vnd.tomtom.mcapi+json
Request Body	ReleaseNotes

Request Parameters

Name	Description	Required
layer	Layer filter.	No
zone	Zone filter.	No

Multiple search terms for the same option are supported (see "Example Requests").
Layer or zone must exactly match the wanted search term or "none" for no layer/zone.

Example Requests

curl -X GET 'https://example.com/releases/25/notes'
    --header 'Accept: application/vnd.tomtom.mcapi+json'
    --header 'Authorization: Bearer <api_key>'

curl -X GET 'https://example.com/releases/25/notes?layer=poi,core'
    --header 'Accept: application/vnd.tomtom.mcapi+json'
    --header 'Authorization: Bearer <api_key>'

curl -X GET 'https://example.com/releases/25/notes?zone=EUR.BEL'
    --header 'Accept: application/vnd.tomtom.mcapi+json'
    --header 'Authorization: Bearer <api_key>'

curl -X GET 'https://example.com/releases/25/notes?zone=none'
    --header 'Accept: application/vnd.tomtom.mcapi+json'
    --header 'Authorization: Bearer <api_key>'

Example Response

HTTP/1.1 200
Content-Type: application/vnd.tomtom.mcapi+json

{
  "notes": [
    {
      "category": "RELEASE_NOTE",
      "zones": [
        {
          "zone": "EUR.BEL",
          "zoneDisplayName": "Belgium",
          "layers": [
            {
              "layer": "Core",
              "content": [
                "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
                "Nunc efficitur felis eu metus posuere ornare."
              ]
            }
          ]
        }
      ]
    }, {
      "category": "META_INFORMATION",
      "zones": [
        {
          ...
        }
      ]
    }
  ]
}