V1
Digitised Objects

Digitised object definition

Returns all the metadata and signposts to the related resources for the given digitised object.

get/v1/digitised-objects/{id}

Request

  • Base URL
    https://api-dor.ncl.ac.uk
  • Auth
    none declared

Path parameters

idstring required

Digitised object's identifier.

Response

The complete definition of the identified digitised object.

idstring required
refCodestring nullable required
titlestring nullable required
descriptionstring nullable required
formatstring nullable required
languagestring nullable required
creatorsstring[] nullable required
subjectsstring[] nullable required
datesstring[] nullable required
placesstring[] nullable required
publishersstring[] nullable required
provenancesstring[] nullable required
contributorsstring[] nullable required
copyrightstring nullable required
licensestring nullable required
manifeststring required
createdAtstring date-time required
updatedAtstring date-time nullable required

Example response

{
  "id": "UkLWZg9D",
  "refCode": "NUA/005671/01",
  "title": "Aerial view of King's College",
  "format": "Photograph",
  "collection": {
    "id": "ngQRYFju",
    "title": "Newcastle University Archives",
    "_links": {
      "definition": {
        "parameters": {
          "?": "..."
        }
      }
    }
  },
  "items": {
    "_links": {
      "search": {
        "parameters": {
          "?": "..."
        }
      }
    }
  },
  "transcript": {
    "_links": {
      "content": {
        "parameters": {
          "?": "..."
        }
      }
    }
  },
  "teis": [
    {
      "id": "UkLWZg9D",
      "_links": {
        "content": {
          "parameters": {
            "?": "..."
          }
        }
      }
    }
  ],
  "_links": {
    "index": {
      "parameters": {
        "?": "..."
      }
    },
    "search": {
      "parameters": {
        "?": "..."
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.