UKuk-hydrographic-office
DRAFT

GET /v1/licences/{licenceId}/s100/holdings

Changed on

Get holdings for the requested licence.

Request

  • Base URL
    https://shop-facade-service-url
  • Auth
    HTTP bearer

Path parameters

licenceIdinteger required
Example:12345678

Licence Id. It must be an integer value and greater than zero.

Response

OK - Returns holdings available for the licence.

unitNamestring

unitName define the type of unit.

unitTitlestring

unitTitle define the title of unit.

expiryDatestring

expiryDate of the unit.

Example response

{
  "unitName": "P1231",
  "unitTitle": "P1231",
  "expiryDate": "2026-01-31T23:59:00Z",
  "datasets": [
    {
      "datasetName": "101GB40079ABCDEFG.000",
      "datasetTitle": "101GB40079ABCDEFG",
      "latestEditionNumber": 1,
      "latestUpdateNumber": 11
    }
  ]
}

Changes