Event Calendar API

A new API endpoint has been added to retrieve event session records in a date range. The endpoint is:

• GET /events/1.0/sessions/calendar

See the Swagger Events API interface to try it out.

Additional API endpoints to retrieve current & previous loans, and reservations

There is no server version requirement for this feature.

A new API endpoint has been added to retrieve current loans. The endpoint is:

• GET /circulation/1.0/patrons/id/{patronId}/loans/current

A new API endpoint has been added to retrieve previous loans. The endpoint is:

• GET /circulation/1.0/patrons/id/{patronId}/loans/previous

A new API endpoint has been added to retrieve current reservations. The endpoint is:

• GET /circulation/1.0/patrons/id/{patronId}/reservations/current

A new API endpoint has been added to retrieve previous reservations. The endpoint is:

• GET /circulation/1.0/patrons/id/{patronId}/reservations/previous

See the Swagger Circulation API interface to try them out.

Add response fields to patron reservations methods

Two response fields have been added to the current & previous reservation API calls.

•     pickupLocationCode
•     reservationStatus

The reservationStatus field will be set per LCF standards.

For current reservations;

• If a reservation is allocated, and not in transit (i.e. it has arrived at the pickup location), reservationStatus will be set to 01 (Item available - in hold queue)
• If a reservation is allocated, and in transit (i.e. has not yet arrived at the pickup location), reservationStatus will be set to 02 (Unavailable hold item)
• If a reservation is not yet allocated, reservationStatus will be set to 02 (Unavailable hold item)

For previous reservations, reservationStatus will be based on the reservation completion type:

• where a reservation was cancelled (C) or automatically cancelled (S), reservationStatus will be set to 03 (Reservation cancelled by patron)
• where a reservation was completed by being issued (I), automatically completed (A), or completed as a part of a multi-title reservation (M), reservationStatus will be set to 05 (Ended by check-out to patron)
• where a a reservation expires without an item ever being allocated (U), or the hold period expires before the item is picked up (E), reservationStatus will be set to 06 (Expired)

Add 'mode' parameter to LCF 1.2 patron information endpoint

There is no server version requirement for this feature.

To help improve performance, the LCF v1.2 patron information method now includes a 'mode' option. There are two patron modes supported:

• 'patron'
• 'auth'

When the mode is set to 'patron,' the response contains no transaction summary information, transaction links, or deposit balance.

When the mode is set to 'auth,' only the patron's credentials are validated, and a response code (200 or 401) is returned. 

If mode is empty or not set to 'patron' or 'auth', the response contains transaction summary information, transaction links and deposit balance.