v1

latestOpenAPI 3.0.3MIT2026-07-23243157.4 KB
Documents

Returns project document

Returns project document

get/api/v3/documents/{caseReference}

Path parameters

caseReferencestring required

Case reference

Query parameters

type'RULE_6_LETTER' | 'RULE_8_LETTER' | 'EXAMINATION_LIBRARY' | 'DECISION_LETTER_APPROVE' | 'DECISION_LETTER_REFUSE' | 'GIS_SHAPEFILE' required

Type of document

Response

Returns a document

idnumber
dataIdstring
caseReferencestring
stagenumber
typestring
filter1string
filter2string
categorystring
descriptionstring
sizenumber
mimestring
publishedDocumentURIstring
pathstring
statusstring
datePublishedstring
deadlineDatestring
personalNamestring
representativestring
whoFromnumber
docReferencestring
authorstring
detailsstring
lastModifiedstring
dateCreatedstring

Example response

{
  "id": 12601,
  "dataId": "TR040009-000004",
  "caseReference": "TR040009",
  "stage": 1,
  "type": "Transboundary",
  "filter1": "Environmental Impact Assessment",
  "size": 50427,
  "mime": "application/pdf",
  "publishedDocumentURI": "https://example.com/published/myDoc.pdf",
  "path": "TR040009/TR040009-000004-Regulation 24 Transboundary Screening document.pdf",
  "status": "Published",
  "datePublished": "2015-06-10",
  "lastModified": "2016-04-28 08:42:58",
  "dateCreated": "2016-04-28 08:42:58"
}