libraries/{library_id}/borrowers/{id}

Returns a borrower for a given library, specified by library ID, with basic information on the account, preferred branch and user associated with the account.

PRIVATE API — Returns "403 Forbidden" unless api_key parameter matches a private API key that has been configured for this purpose.  Please contact BiblioCommons for access. The API key used here should not be shared in source code or otherwise.

Resource URL

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

Request Parameters

Parameter Type Description Default Required?
library_id String The library ID.  Each library's BiblioCommons catalog will have a hostname of the form {library_id}.bibliocommons.com.  The {library_id} portion of the hostname is the library's ID. N/A Yes
id String The borrower ID to look up, as remembered or returned by the /sessions/ API. N/A Yes

Response Fields

Response Field Type Description Returned
id String The unique borrower ID. Always
barcode String The barcode associated with this borrower. Always
library_borrower_type String The type of borrower, as coded in the ILS. Always
email String The borrower's email address. Always
first_name String The borrower's first name. Always
last_name String The borrower's last name. Always
phone String The borrower's phone number. Always
cell_phone String The borrower's cell phone number. Always
expiry_date String The expiry date of the borrower's account. Always
birth_date String The borrower's birth date. Always
location Object The first preferred library location (branch). Always
   id String The library-specific location ID. Always
   name String The user-friendly name of the library location. Always
user Object The user details for this borrower.  See users Response Fields. Always
interest_groups Object[] Interest Groups (If supported by library) Optional
   id String The machine-readable interest group ID. Always
   name String Name of interest (as shown on registration form if supported) Always

Example Request

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

Response:

{
  "borrower": {
    "id": "654321",
    "barcode": "123456789012",
    "library_borrower_type": "p",
    "email": "example@example.com",
    "first_name": "Example",
    "last_name": "User",
    "phone": "613-123-1234",
    "cell_phone": "613-123-1234"  
    "expiry_date": "2013-01-31T00:00:00Z",
    "birth_date": "1973-01-01T00:00:00Z", 
    "location": {
      "id": "AL",
      "name": "Anytown Library"
    },
    "user": {
      "id": "987654321",
      "name": "exampleuser",
      "profile_url": "http://examplepl.bibliocommons.com/collection/show/987564321"
    },
    "interest_groups": [
      {
        "id": "teacher_high_school",
        "name": "Teacher - High School"
      },
      {
        "id": "writer",
        "name": "Author/Writer/Journalist/Poet"
      }
    ]
  }
}

version 14 as of 4 months ago by natashadalal