Skip to content

constituent.md

Latest commit

 

History

History
243 lines (218 loc) · 6.8 KB

constituent.md

File metadata and controls

243 lines (218 loc) · 6.8 KB

Constituents

For the purposes of this API, constituents are the principle creators of an object (you know, the artists).

Endpoints

Endpoint Description
/constituents Index of constituent endpoints
/constituents/{a-z} Alphabetical list of constituents
/constituents/{id} Retrieve constituent with corresponding `id`

Example index response

Request:

curl http://api.guggenheim.org/collections/constituents

Response:

{
    "_links": {
        "_self": {
            "href": "http://api.guggenheim.org/collections/constituents"
        }, 
        "alpha": {
            "href": "http://api.guggenheim.org/collections/constituents/{a-z}"
        }, 
        "item": {
            "href": "http://api.guggenheim.org/collections/constituents/{id}"
        }
    }
}

The index endpoint provides a list of links to other constituent-related endpoints.

/constituents/{a-z}

Returns an alphabetical list of constituents whose last name (or the name by which they are sorted) begins with the given letter. NB: This endpoint returns only constituents with objects in the Guggenheim's permanent collection. Additionally this endpoint only returns the total_count of objects connected to a constituent, not the objects themselves. To access the actual object data connected to a constituent you must make a direct request to the specific constituent id itself.

Example

Request:

curl http://api.guggenheim.org/collections/constituents/u

Response:

{
    "constituents": [
        {
            "_links": {
                "_self": {
                    "href": "http://api.guggenheim.org/collections/constituents/886"
                }
            }, 
            "dates": {
                "begin": 1930, 
                "display": "b. 1930, Wendorf, Mecklenburg, Germany", 
                "end": 0
            }, 
            "display": "G\u00fcnther Uecker", 
            "firstname": "G\u00fcnther", 
            "id": 886, 
            "lastname": "Uecker", 
            "middlename": null, 
            "nationality": "German", 
            "objects": {
                "total_count": 1
            }, 
            "sort": "Uecker, G\u00fcnther", 
            "suffix": null
        }, 
        {
            "_links": {
                "_self": {
                    "href": "http://api.guggenheim.org/collections/constituents/7585"
                }
            }, 
            "dates": {
                "begin": 1968, 
                "display": "b. 1968, Warsaw, Poland", 
                "end": 0
            }, 
            "display": "Piotr Uklanski", 
            "firstname": "Piotr", 
            "id": 7585, 
            "lastname": "Uklanski", 
            "middlename": null, 
            "nationality": "Polish", 
            "objects": {
                "total_count": 1
            }, 
            "sort": "Uklanski, Piotr", 
            "suffix": null
        }
    ]
}

/constituents/{id}

Returns the constituent with the corresponding id. Additionally the full list of objects connected to this constituent—including images connected to the object—is returned as well.

Example

Request:

curl http://api.guggenheim.org/collections/constituents/1515

Response:

{
    "id": 1515, 
    "firstname": "Vasily", 
    "middlename": null, 
    "lastname": "Kandinsky", 
    "suffix": null,
    "display": "Vasily Kandinsky", 
    "sort": "Kandinsky, Vasily", 
    "dates": {
        "begin": 1866, 
        "end": 1944,
        "display": "b. 1866, Moscow, Russia; d. 1944, Neuilly-sur-Seine, France"
    }, 
    "nationality": "Russian", 
    "objects": {
        "items": [
            {...},
            {...},
            ...
        ], 
        "total_count": 17,
        "count": 17, 
        "items_per_page": 20, 
        "page": 1, 
        "pages": 1
    }, 
    "_links": {
        "_self": {
            "href": "http://api.guggenheim.org/collections/constituents/1515"
        }
    }
}

Constituent fields

Field Type Req'd? Description
id number REQUIRED Unique ID number for the constituent
firstname string REQUIRED The constituent's first name, may be null
middlename string REQUIRED The constituent's middle name, may be null
lastname string REQUIRED The constituent's last name, may be null
suffix string REQUIRED A suffix to be added to the name, may be null. Examples: "Jr.", "The Younger"
display string REQUIRED A version of the name, usually some combination of the previous foru fields, suitable for display
sort string REQUIRED A version of the name suitable for alphatic sorting
dates object REQUIRED A Dates object
nationality string REQUIRED The constituent's nationality
objects object REQUIRED A paginated object resource
_links object REQUIRED A links resource