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

Locations

The Locations API allows people to retrieve info about locations.

DESCRIPTION

Returns all locations, filtered by the 'locality' GET filter.

PARAMETERS

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

Example Success Response

{
    "links": {
        "self": "https://avian.lib.iastate.edu/api/v1/locations?locality=adair"
    },
    "data": [
        {
            "id": 686,
            "type": "location",
            "attributes": {
                "status": "Reviewed",
                "higherGeographyUri": "4846344",
                "continent": "North America",
                "waterBody": "",
                "islandGroup": "",
                "island": "",
                "country": "United States",
                "countryCode": "US",
                "stateProvince": "Iowa",
                "county": "Adair County",
                "municipality": "",
                "locality": "Adair County",
                "latitude": 41.33075,
                "longitude": -94.47094,
                "locationAccordingTo": "Geonames",
                "geodeticDatum": "WGS 84",
                "adminNotes": ""
            }
        },
        {
            "id": 1800,
            "type": "location",
            "attributes": {
                "status": "Not Reviewed",
                "higherGeographyUri": "4846339",
                "continent": "North America",
                "waterBody": "",
                "islandGroup": "",
                "island": "",
                "country": "United States",
                "countryCode": "US",
                "stateProvince": "Iowa",
                "county": "Adair County",
                "municipality": "Adair",
                "locality": "Adair",
                "latitude": 41.50054,
                "longitude": -94.64359,
                "locationAccordingTo": "Geonames",
                "geodeticDatum": "WGS 84",
                "adminNotes": ""
            }
        }
    ]
}

DESCRIPTION

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

PARAMETERS

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

Example Success Response

{
    "links": {
        "self": "https://avian.lib.iastate.edu/api/v1/locations/8"
    },
    "data": {
        "id": "1",
        "type": "location",
        "attributes": {
            "status": "Reviewed",
            "higherGeographyUri": "4398678",
            "continent": "North America",
            "waterBody": null,
            "islandGroup": null,
            "island": null,
            "country": "United States",
            "countryCode": "US",
            "stateProvince": "Missouri",
            "county": "",
            "municipality": null,
            "locality": "Missouri",
            "latitude": 38.25031,
            "longitude": -92.50046,
            "locationAccordingTo": "Geonames",
            "geodeticDatum": "WGS 84",
            "adminNotes": null
        },
        "relationships": {
            "documents": {
                "data": [
                    {
                        "id": 2289,
                        "type": "document"
                    },
                    {
                        "id": 3192,
                        "type": "document"
                    },
                    {
                        "id": 3518,
                        "type": "document"
                    }
                ]
            }
        }
    }
}