libraries/{id}/locations

Returns the list of locations for a given library, specified by library ID, with basic information about each location.

Resource URL

https://api.bibliocommons.com/v1/libraries/{id}/locations

Request Parameters

Parameter Type Description Default Required?
id String The library ID.  Each library's BiblioCommons catalog will have a hostname of the form {id}.bibliocommons.com.  The {id} portion of the hostname is the library's ID. N/A Yes

Response Fields

Response Field Type Description Returned
id String The library-specific location ID. Always
name String The user-friendly name of the library location. Always

Example Request

GET https://api.bibliocommons.com/v1/libraries/examplepl/locations?api_key={key}

Response:

{
  "locations": [
    {
      "id": "MA",
      "name": "Main Branch"
    },
    {
      "id": "JP",
      "name": "Johnson Park"
    },
    {
      "id": "RH",
      "name": "Riverdale Heights"
    }
  ] 
}