API (v1) documentation for Document object • Iowa State University • Avian Archives of Iowa Online

Document

The Document API allows people to retrieve info about documents.

DESCRIPTION

Returns all documents, filtered by the 'title' GET filter. There are a lot of documents and this may take a few seconds to run.

PARAMETERS

Parameter	Type	Required	Description	Values	Default
title	GET	Optional	The document title to filter by.	Any text	NULL

RESPONSE

Type: application/json

A JSON object that complies with the JSON API standard (www.jsonapi.org).

Status Code	Meaning
200	Successfully queried documents.
401	Invalid API key provided.
405	Invalid request HTTP method.

Example Success Response

{
    "links": {
        "self": "https://avian.lib.iastate.edu/api/v1/documents?title=union"
    },
    "data": [
        {
            "id": 3,
            "type": "document",
            "attributes": {
                "status": "Exported",
                "creationDate": "2017-09-05 13:29:59",
                "datasetId": null,
                "datasetName": null,
                "institutionCode": "iwa",
                "collectionCode": null,
                "collection": "ms 166",
                "recordBasis": "Human Observation",
                "dataPublisher": "Iowa State University Library Special Collections and University Archives",
                "cdmLink": "",
                "digitalObjectType": "manuscript",
                "type": [
                    "text"
                ],
                "title": "Iowa Ornithologists' Union pamphlet",
                "box": 1,
                "folder": "6",
                "contributingInstitution": "Iowa State University Library Special Collections and University Archives",
                "verbatimLocality": null,
                "locationRemarks": null,
                "zipCode": null,
                "sortStartDate": "1992-01-01 00:00:00",
                "sortEndDate": "1992-01-31 00:00:00",
                "displayDate": "",
                "indexDate": null,
                "time": null,
                "description": "Iowa Ornithologists' Union promotional pamphlet printed in January 1992.",
                "rights": "ISU",
                "dataAccessRights": null,
                "dataLicense": "http://creativecommons.org/publicdomain/zero/1.0",
                "extent": 2,
                "extentType": "pages",
                "language": [
                    "eng",
                    "deu"
                ],
                "dateModified": null,
                "bibliographicCitation": "",
                "informationWithheld": null,
                "occurrenceId": null,
                "individualCount": null,
                "occurrenceStatus": null,
                "occurrenceRemarks": null,
                "habitat": null,
                "fieldNumber": null,
                "eventRemarks": null,
                "supportingDocumentation": null,
                "adminNotes": "",
                "selectionNotes": "ID 25",
                "dateDigital": "2017-04-24 00:00:00",
                "fileName": "MS0166b001f006i0005 | MS0166b001f006i0006",
                "hardware": "Epson - sheet feed"
            }
        }
    ]
}

DESCRIPTION

Returns info about the Document entity associated with the given ID.

PARAMETERS

Parameter	Type	Required	Description	Values	Default
document-id	URL_SLUG	Required	The ID of the Document entity to retrieve.	Any positive integer	NULL

RESPONSE

Type: application/json

A JSON object that complies with the JSON API standard (www.jsonapi.org).

Status Code	Meaning
200	Successfully queried specified document.
401	Invalid API key provided.
404	No document was found for the provided ID.
405	Invalid request HTTP method.

Example Success Response

{
    "links": {
        "self": "https://avian.lib.iastate.edu/api/v1/documents/5"
    },
    "data": {
        "id": "5",
        "type": "document",
        "attributes": {
            "status": "Exported",
            "creationDate": "2017-09-05 13:29:59",
            "datasetId": null,
            "datasetName": null,
            "institutionCode": "iwa",
            "collectionCode": null,
            "collection": "ms 166",
            "recordBasis": "Human Observation",
            "dataPublisher": "Iowa State University Library Special Collections and University Archives",
            "cdmLink": "",
            "digitalObjectType": "manuscript",
            "type": [
                "text"
            ],
            "title": "Iowa Ornithologists' Union pamphlet",
            "box": 1,
            "folder": "6",
            "contributingInstitution": "Iowa State University Library Special Collections and University Archives",
            "verbatimLocality": null,
            "locationRemarks": null,
            "zipCode": null,
            "sortStartDate": "2001-01-19 00 =\u003E00 =\u003E00",
            "sortEndDate": null,
            "displayDate": "",
            "indexDate": null,
            "time": null,
            "description": "Iowa Ornithologists' Union promotional pamphlet printed January 19, 2001.",
            "rights": "ISU",
            "dataAccessRights": null,
            "dataLicense": "http://creativecommons.org/publicdomain/zero/1.0",
            "extent": 2,
            "extentType": "pages",
            "language": [
                "eng"
            ],
            "dateModified": null,
            "bibliographicCitation": "",
            "informationWithheld": null,
            "occurrenceId": null,
            "individualCount": null,
            "occurrenceStatus": null,
            "occurrenceRemarks": null,
            "habitat": null,
            "fieldNumber": null,
            "eventRemarks": null,
            "supportingDocumentation": null,
            "adminNotes": "",
            "selectionNotes": "ID 27",
            "dateDigital": "2017-04-24 00:00:00",
            "fileName": "MS0166b001f006i0009 | MS0166b001f006i0010",
            "hardware": "Contex - flatbed"
        },
        "relationships": {
            "creators": {
                "data": [
                    {
                        "id": 100,
                        "type": "person"
                    }
                ]
            },
            "contributors": {
                "data": []
            },
            "people": {
                "data": [
                    {
                        "id": 100,
                        "type": "person"
                    }
                ]
            },
            "topics": {
                "data": [
                    {
                        "id": 16,
                        "type": "topic"
                    },
                    {
                        "id": 99,
                        "type": "topic"
                    },
                    {
                        "id": 149,
                        "type": "topic"
                    }
                ]
            },
            "birds": {
                "data": []
            },
            "locations": {
                "data": [
                    {
                        "id": 182,
                        "type": "location"
                    }
                ]
            },
            "associatedDocuments": {
                "data": []
            }
        }
    }
}