NCncl
V1
Items

Item definition

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

get/v1/items/{id}/{position}

Request

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

Path parameters

idstring required

Parent's digitised object identifier.

positionnumber required

Item's position within the digitised object's structure.

Response

The complete definition of the identified item.

idstring required
positionnumber
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
canvasstring required

Example response

{
  "id": "UkLWZg9D/3",
  "position": 3,
  "refCode": "Alderson Collection PAR PET",
  "title": "Page 1",
  "description": "First page of Chapter 1.",
  "format": "Illustration",
  "digitisedObject": {
    "id": "UkLWZg9D",
    "title": "Peter Parley's Visit to London During the Coronation of Queen Victoria",
    "description": "Colour illustrations depicting coronation of Queen Victoria",
    "_links": {
      "definition": {
        "parameters": {
          "?": "..."
        }
      }
    }
  },
  "transcript": {
    "_links": {
      "content": {
        "parameters": {
          "?": "..."
        }
      }
    }
  },
  "_links": {
    "index": {
      "parameters": {
        "?": "..."
      }
    },
    "search": {
      "parameters": {
        "?": "..."
      }
    }
  }
}

Changes

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