Branch Object

Click the links below to view the Branch Object properties and an example.

id

integer

(Always returned in the response.)

A unique ID corresponding to the branch.

Example: 

"id": 1

name

string (optional)

The branch name.

Example: 

"name": "Kings Library"

address

string (optional)

The branch address.

Example: 

"address": "Kings Library$150 E San Fernando St$San Jose, CA 95112"

emailSource

string (optional)

The "From" address in the header of an emailed overdue notice,

Example: 

"emailSource": "do-not-reply@sjlibrary.org"

emailReplyTo

string (optional)

The "Reply To" address in the header of an emailed overdue notice.

Example: 

"emailReplyTo": "do-not-reply@sjlibrary.org"

latitude

number (optional)

(Provided when available.)

The latitude of the branch address for geocoding.

Example: 

"latitude": 37.3360353

longitude

number (optional)

(Provided when available.)

The longitude of the branch address for geocoding.

Example: 

"longitude": -121.8859396

The preceding list order reflects the sequence in which the data returns.

The Branch object returns all available properties by default.

Example response for:

https://example-library.edu:443/iii/sierra-api/v6/branches/1
{
  "id": 1,
  "name": "Kings Library",
  "address": "King Library$150 E San Fernando St$San Jose, CA 95112",
  "emailSource": "do-not-reply@sjlibrary.org",
  "emailReplyTo": "do-not-reply@sjlibrary.org",
  "latitude": 37.3360353,
  "longitude": -121.8859396
}