Versions Compared

Version Old Version 27 New Version 28
Changes made by

Irina Pokhylets

Irina Pokhylets

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

References

...

  • record_type:Public

  • primary_id: The primary identifier of the user

  • Account_type: External

  • User_group (optional): Used in fulfillment policies

  • last_name: Used in displays and search

...

  • Parameters:

    • mms_id: Bib record ID

  • Mandatory Fields:

    • The actual record: XML string describing the record

    • suppress_from_publishing: tbd

  1. Create Item

    • Parameters:

      • Barcode

      • physical_material_type

      • policy: Interlibrary Loan

      • location?

...

Lifecycle

Given

When

Then

Dispatched by Supplying Library

  • DCB Patron Request exists in status REQUEST_PLACED_AT_BORROWING_AGENCY

DCB Patron Request Workflow matches corresponding request details at

  • Alma Supplying Library:

    • Request status: In progress

    • Item status: Transit

Trigger DCB HandleSupplierInTransit event to change

  • Borrowing or Pickup Library

    • transaction state = OPEN

  • DCB

    • PatronRequest.PICKUP_TRANSIT

    • HostLmsItem.ITEM_PICKUP_TRANSIT

Received at Pickup Library

  • DCB Patron Request exists

    • with corresponding HostLmsItem.ITEM_PICKUP_TRANSIT

DCB Patron Request Workflow matches corresponding request details at

  • Pickup Library

    • transaction state = AWAITING_PICKUP

Trigger HandleBorrowerItemOnHoldShelf event to change

  • Borrowing or Pickup Library

    • transaction state =AWAITING_PICKUP

  • DCB

    • PatronRequest.READY_FOR_PICKUP

    • HostLmsItem.ITEM_ON_HOLDSHELF

  • Alma Supplying Library:

    • On hold shelf / Ready for pickup

Item Checked Out to Patron at Pickup Library

  • DCB Patron Request exists

    • with corresponding HostLmsItem.ITEM_ON_HOLDSHELF

DCB Patron Request Workflow matches corresponding request details at

  • Pickup Library

    • transaction state = ITEM_CHECKED_OUT

Trigger HandleBorrowerItemLoaned event to change

  • Borrowing or Supplying Library

    • transaction state = ITEM_CHECKED_OUT

  • DCB

    • PatronRequest.LOANED

    • HostLmsItem.ITEM_LOANED

  • Alma Supplying Library

    • Request status: In progress

    • Item status: Loan

    • Loan is createdstatus: Active, the item is checked out to a patron.

Item Returned by Borrowing Patron

  • DCB Patron Request exists in status

    • with corresponding HostLmsItem.ITEM_LOANED

DCB Patron Request Workflow matches corresponding request details at either

  • Pickup or Borrowing Library

    • transaction state = ITEM_CHECKED_IN

Trigger HandleBorrowerRequestReturnTransit event to change at

  • Borrowing or Pickup Library

    • transaction state = ITEM_CHECKED_IN

    • loan status = Closed

    • virtual item status = In transit

  • DCB

    • PatronRequest.RET-TRANSIT

    • HostLmsItem.ITEM_RETURNED

  • Alma Supplying Library:

    • no changes?

Received Back at Lending Agency

  • DCB Patron Request exists in status

    • with corresponding HostLmsItem.ITEM_RETURNED

DCB Patron Request Workflow matches corresponding request details at either

  • Alma Supplying Library

    • Request status: Closed?

    • Item status: Item in place /Transit for Reshelving?

    • Loan is closedstatus:

      • In Transit: If the item is returned to a non-owning branch and is being sent back to its home location

      • Returned: The item has been returned to the library and is no longer checked out.

Trigger HandleBorrowerRequestReturnTransit event to change

  • Borrowing or Pickup Library

    • transaction state = CLOSED

  • DCB

    • PatronRequest.COMPLETED

    • HostLmsItem.ITEM_AVAILABLE

    • Local status on supplier request changed to AVAILABLE

...

Alma status updates:

  • Request status: Closed?Completed

  • Item status: Item in place

  •  Loan is closed

...

Circulation tracking and reaction (borrowing)

tbd

Finalization

In Alma, request cancellation can be performed automatically by REST API, manually in Alma by a staff member.

Cancel user request by API

API key parameters and mandatory fields include:

  • Parameters:

    • user_id: The ID of the requesting user.

    • request_id: A unique identifier of the request that should be canceled.

  • Mandatory Fields:

    • reason: CancelledAtPatronRequest

For more details on cancellation request by API can be found here

Cancel user request manually in Alma

...

Common Request Closure Statuses in Alma

  1. Completed. The request has been successfully fulfilled.

  2. Canceled. The request has been canceled, either manually by a user/staff member or automatically by the system.

  3. Expired. The request has expired without being fulfilled, based on library-defined expiration rules.

  4. Rejected. The request was rejected by library staff or the system due to eligibility, policy, or technical reasons.

  5. Failed. The request could not be fulfilled due to a failure in the process.

  6. Hold Shelf Expired. The item was placed on the hold shelf but was not picked up within the designated time frame.

Retrieving Request Closure Status via API

Endpoint:

GET /almaws/v1/bibs/{mms_id}/requests

Example Request:

Code Block
http
GET https://api-na.hosted.exlibrisgroup.com/almaws/v1/bibs/123456789/requests?apikey={your_api_key}

Key Fields in Response:

  • request_status: Shows the current or final status of the request.

  • expiry_date: Indicates the expiration date, if applicable.

  • pickup_location: Provides the location where the item was to be picked up.

Example Response:

Code Block
json

{
  "total_record_count": 2,
  "requests": [
    {
      "request_id": "12345",
      "request_status": "Completed",
      "expiry_date": "2024-11-30T23:59:00Z",
      "pickup_location": "Main Library"
    },
    {
      "request_id": "67890",
      "request_status": "Canceled",
      "expiry_date": null,
      "pickup_location": "Science Library"
    }
  ]
}

Cancel a request in Alma via the API

Endpoint:

DELETE /almaws/v1/bibs/{mms_id}/requests/{request_id}

Required Parameters

  1. mms_id: The bibliographic record ID of the item for which the request was made.

  2. request_id: The unique identifier of the request to be canceled.

Required Parameters

  1. mms_id: The bibliographic record ID of the item for which the request was made.

  2. request_id: The unique identifier of the request to be canceled.

Example Request

Code Block
http
DELETE https://api-na.hosted.exlibrisgroup.com/almaws/v1/bibs/123456789/requests/987654321?reason=User%20no%20longer%20needs%20item&apikey={your_api_key}

Default request-cancellation reasons