Skip to content

sites.md

Latest commit

 

History

History
251 lines (228 loc) · 6.15 KB

sites.md

File metadata and controls

251 lines (228 loc) · 6.15 KB

Sites

Besides the Solomon R. Guggenheim Museum in New York, the Solomon R. Guggenheim foundation collaborates with a network of institutions worldwide, such as the Guggenheim Museum in Bilbao and the Peggy Guggenheim Collection in Venice. The sites/ endpoint allows you to retrieve information about these sites and their collections.

Endpoints

Endpoint Description Returns
/sites Index of sites Array of Site objects
/sites/{id} Retrieve site with corresponding `id` One Site object

/sites

Returns an all sites in the collection as an array of Site objects. Each Site has a paginated objects resource.

Parameter Req'd? Description
per_page optional The maximum number of items on to return on each page (Default 5, maximum 100).
no_objects optional If set to any value, return only a count of the total number of objects for each site. This option overrides page and per_page.

Example

Request:

curl http://api.guggenheim.org/sites?no_objects=1

Response:

{
    "_links": {
        "_self": {
            "href": "http://api.guggenheim.org/sites"
        }, 
        "item": {
            "href": "http://api.guggenheim.org/sites/{id}"
        }
    }, 
    "sites": [
        {
            "_links": {
                "_self": {
                    "href": "http://api.guggenheim.org/sites/3"
                }
            }, 
            "id": 3, 
            "location": "New York", 
            "name": "Solomon R. Guggenheim Museum", 
            "objects": {
                "total_count": 823
            }
        }, 
        {
            "_links": {
                "_self": {
                    "href": "http://api.guggenheim.org/sites/5"
                }
            }, 
            "id": 5, 
            "location": "Berlin", 
            "name": "Deutsche Guggenheim Berlin", 
            "objects": {
                "total_count": 52
            }
        }, 
        {
            "_links": {
                "_self": {
                    "href": "http://api.guggenheim.org/sites/6"
                }
            }, 
            "id": 6, 
            "location": "Bilbao", 
            "name": "Guggenheim Museum Bilbao", 
            "objects": {
                "total_count": 40
            }
        }, 
        {
            "_links": {
                "_self": {
                    "href": "http://api.guggenheim.org/sites/7"
                }
            }, 
            "id": 7, 
            "location": "Venice", 
            "name": "Peggy Guggenheim Collection", 
            "objects": {
                "total_count": 111
            }
        }
    ]
}

/sites/{id}

Returns the Site specified by the id.

Parameter Req'd? Description
page optional The page of the paginated objects resource to return (default 1).
per_page optional The maximum number of items on to return on each page (default 20, maximum 100). 5
no_objects optional If set to any value, return only a count of the total number of objects. This option overrides page and per_page.

Example

Request:

curl http://api.guggenheim.org/sites/3

Response:

{
    "id": 3, 
    "name": "Solomon R. Guggenheim Museum", 
    "location": "New York", 
    "objects": {
        "count": 20, 
        "items": [
            {...},
            {...},
            ...
        ], 
        "items_per_page": 20, 
        "page": 1, 
        "pages": 42, 
        "total_count": 823
    },
    "_links": {
        "_self": {
            "href": "http://api.guggenheim.org/sites/3"
        }, 
        "next": {
            "href": "http://api.guggenheim.org/sites/3?page=2&per_page=20"
        }
    } 
}

Site objects

Site fields

Field Type Req'd? Description
id number REQUIRED Unique ID number for the site
name string REQUIRED Name of the site
location string REQUIRED Location of the site
objects object REQUIRED A paginated objects object
_links object REQUIRED A links object