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

Person

The Person API allows people to retrieve info about people.

DESCRIPTION

Returns all persons, filtered by the 'name' GET filter.

PARAMETERS

Parameter	Type	Required	Description	Values	Default
name	GET	Optional	The name to filter people 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 people.
401	Invalid API key provided.
405	Invalid request HTTP method.

Example Success Response

{
    "links": {
        "self": "https://avian.lib.iastate.edu/api/v1/people?name=barker"
    },
    "data": [
        {
            "id": 4,
            "type": "person",
            "attributes": {
                "status": "Reviewed",
                "maintenanceStatus": "deletedReplaced",
                "maintenanceAgency": "Iowa State University Library Special Collections and University Archives",
                "rulesAndVocabularies": "viaf",
                "maintenanceEvent": "",
                "recordSource": "",
                "nameType": "person",
                "nameUri": "96711506",
                "name": "Barker, W. R. - Do Not Use",
                "source": "viaf",
                "historicalNote": "",
                "adminNotes": "VIAF record appears to be connected to an Australian. Unlikely to be the same Bill Barker as was spotting birds in Davenport in 1985, who is likely Ann Barker's husband."
            }
        },
        {
            "id": 147,
            "type": "person",
            "attributes": {
                "status": "Reviewed",
                "maintenanceStatus": "new",
                "maintenanceAgency": "Iowa State University Library Special Collections and University Archives",
                "rulesAndVocabularies": "rda",
                "maintenanceEvent": null,
                "recordSource": null,
                "nameType": "person",
                "nameUri": null,
                "name": "Barker, Ann M.",
                "source": "local",
                "historicalNote": null,
                "adminNotes": null
            }
        }
    ]
}

DESCRIPTION

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

PARAMETERS

Parameter	Type	Required	Description	Values	Default
person-id	URL_SLUG	Required	The ID of the Person 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 person.
401	Invalid API key provided.
404	No person was found for the provided ID.
405	Invalid request HTTP method.

Example Success Response

{
    "links": {
        "self": "https://avian.lib.iastate.edu/api/v1/people/10"
    },
    "data": {
        "id": "10",
        "type": "person",
        "attributes": {
            "status": "Reviewed",
            "maintenanceStatus": "new",
            "maintenanceAgency": "Iowa State University Library Special Collections and University Archives",
            "rulesAndVocabularies": "viaf",
            "maintenanceEvent": null,
            "recordSource": null,
            "nameType": "person",
            "nameUri": "314907044",
            "name": "Bird, Richard E.",
            "source": "viaf",
            "historicalNote": null,
            "adminNotes": "Bird, Richard"
        },
        "relationships": {
            "createdDocuments": {
                "data": [
                    {
                        "id": 177,
                        "type": "document"
                    }
                ]
            },
            "contributions": {
                "data": [
                    {
                        "id": 121,
                        "type": "document"
                    }
                ]
            },
            "documents": {
                "data": [
                    {
                        "id": 11,
                        "type": "document"
                    }
                ]
            }
        }
    }
}