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

Genre

The Genre API allows people to retrieve info about genres.

DESCRIPTION

Returns all genres, filtered by the 'genre' GET filter.

PARAMETERS

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

Example Success Response

{
    "links": {
        "self": "https://avian.lib.iastate.edu/api/v1/genres?genre=Administrative"
    },
    "data": [
        {
            "id": 2,
            "type": "genre",
            "attributes": {
                "genre": "Administrative reports",
                "uri": "http://vocab.getty.edu/aat/300027268",
                "source": "aat",
                "active": true,
                "adminNotes": "Official or formal records outlining administrative details, or events sucha as functions, proceedings, or investigations. Annual reports, membership reports, etc."
            }
        },
        {
            "id": 3,
            "type": "genre",
            "attributes": {
                "genre": "Administrative records",
                "uri": "http://vocab.getty.edu/aat/300027425",
                "source": "aat",
                "active": true,
                "adminNotes": "Records that relate to budget, personnel, supply, and similar facilitative operations within an organization. Budgets, constitutions, staff lists, etc."
            }
        }
    ]
}

DESCRIPTION

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

PARAMETERS

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

Example Success Response

{
    "links": {
        "self": "https://avian.lib.iastate.edu/api/v1/genre/2"
    },
    "data": {
        "id": "2",
        "type": "genre",
        "attributes": {
            "genre": "Administrative reports",
            "uri": "http =\u003E//vocab.getty.edu/aat/300027268",
            "source": "aat",
            "active": true,
            "adminNotes": "Official or formal records outlining administrative details, or events sucha as functions, proceedings, or investigations. Annual reports, membership reports, etc."
        },
        "relationships": {
            "documents": {
                "data": [
                    {
                        "id": 102,
                        "type": "document"
                    },
                    {
                        "id": 123,
                        "type": "document"
                    },
                    {
                        "id": 139,
                        "type": "document"
                    }
                ]
            }
        }
    }
}