v1

latestOpenAPI 3.0.02026-07-239914.4 KB

Data Packages

Get a specific data package version, including details of the files that are available to download.

get/dataPackages/{dataPackageId}/versions/{versionId}

Path parameters

dataPackageIdstring required

The id of the data package.

versionIdstring required

The id of the data package version, or the string 'latest'.

Response

A data package version, including download details.

idstring required

urlstring uri required

createdOnstring date required

reason'INITIAL' | 'UPDATE' | 'EXPANSION' | 'RESUPPLY' | 'ONLINE_ORDER' required

supplyType'FULL' | 'COU' required

productVersionstring required

formatstring

dataPackageUrlstring uri

nextVersionUrlstring uri

Only populated if there is a newer version of the data package.

previousVersionUrlstring uri

Only populated if there is an older version of the data package.

Example response

{
  "id": "110012",
  "url": "https://api.os.uk/downloads/v1/dataPackages/0040046952/versions/110012",
  "createdOn": "2021-04-01",
  "productVersion": "E37 December 2015 Update",
  "format": "CSV",
  "dataPackageUrl": "https://api.os.uk/downloads/v1/dataPackages/0040046952",
  "nextVersionUrl": "https://api.os.uk/downloads/v1/dataPackages/0040046952/versions/110013",
  "previousVersionUrl": "https://api.os.uk/downloads/v1/dataPackages/0040046952/versions/110011",
  "downloads": [
    {
      "fileName": "data.zip",
      "size": 1234,
      "md5": "2f9dd13abd56140afa3b5621e8864f59"
    }
  ]
}