List of collections

Returns summary of collections present in the system.

get/v1/collections

Request

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

Query parameters

pagenumber

The pagination index, starting from 1 for the first page.

page.sizenumber

The number of collections matching returned per page, between 1 and 100.

page.startnumber

The pagination starting offset starting from 0.

Response

The list of collections matching a query.

Example response

{
  "items": [
    {
      "id": "ngQRYFju",
      "title": "Newcastle University Archives",
      "_links": {
        "definition": {
          "parameters": {
            "?": "..."
          }
        }
      }
    }
  ],
  "pagination": {
    "_links": {
      "first": {
        "parameters": {
          "?": "..."
        }
      },
      "previous": {
        "parameters": {
          "?": "..."
        }
      },
      "next": {
        "parameters": {
          "?": "..."
        }
      },
      "last": {
        "parameters": {
          "?": "..."
        }
      }
    }
  },
  "_links": {
    "home": {
      "parameters": {
        "?": "..."
      }
    }
  }
}

Changes

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