Collection Lookup API

Owned by Former user (Deleted)
Jun 02, 2016
2 min read

Collection Lookup API: http://core.tdar.org/lookup/collection

To search for collections in tDAR

Requests:

To make a request to the collection lookup API, you will need a "title."

Parameters:

  • term: the term to search for (searches title & keyword).
  • startRecord: the first record to display (for pagination)
  • recordsPerPage: the number of records to return
  • sortField: how to sort the results, default is relevance.

Response:

The response will include the following information:

  1. A list of "items" that contains the name, id, and a full URL for the collection.
  2. A status object containing the number of results, records per page, and sorting options.

Example:

URL: http://core.tdar.org/lookup/collection?term=NABO

A sample search for "NABO"

 

http://core.tdar.org/lookup/collection?term=NABO
{
    "collections": [
        {
            "description": "",
            "id": 24579,
			"detailUrl": "/collection/24579/nabo",
            "name": "NABO"
        },
        {
            "description": "The North Atlantic Archaeofaunal data sets listed here resulted from joint NABO projects. The faunal remains were analyzed according to the guidelines of the Zooarchaeology Working Group Data Records Project, authorized by the January 1997 working group meeting in New York City. The basic structure follows James Rackham\u2019s database (Microsoft Access) with some changes and clarifications for North Atlantic applications. The Hunter Bioarchaeology lab was charged with adapting the Rackham system to the realities of modern work in the North Atlantic, and to balance recorded detail with the need for rapid and consistent processing of the large bone collections now becoming common in our research area. A particular concern was the need to promote long term data comparability and to provide both a long term data archive and a set of analytic tools immediately addressing current joint research objectives. The NABONE system consists of this coding manual, a developed Microsoft Access database with useful queries and reports, and an Excel spreadsheet set providing analytic output similar to the old Hunter College QBONE system. This package is available for download on the NABO website (http://www.nabohome.org) and was utilized for all site-specific archaeofaunal collections provided here.",
            "id": 24577,
			"detailUrl": "/collection/24577/nabo-zooarchaeology-data",
            "name": "NABO Zooarchaeology Data"
        }
    ],
    "status": {
        "recordsPerPage": 25,
        "sortField": "RELEVANCE",
        "startRecord": 0,
        "totalRecords": 2
    }
}