Versions Compared

Key

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

References

...

Creating an item-level request in Alma

Create a Request API allows to create an Item-level requests can be created using the Rest User request API. Key parameters and mandatory fields include:

Parameters:

...

Bib/Holding/Item ID: The bibliographic, holding, or item ID.

...

Endpoint

POST /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/requests

Required Parameters

  1. mms_id: The unique identifier of the bibliographic record.

  2. holding_id: The ID of the holding record associated with the item.

  3. item_pid: The unique identifier of the physical item.

Key parameters and mandatory fields include:

  • user_primary_id: The ID of the requesting user.

  • Mandatory Fields:

    request_type: HOLD

  • pickup_location_type: LIBRARY

  • pickup_location_library: The pickup location library code.

  • material_type (optional): Used in fulfillment policies.

Hold request example

Code Block
http
POST https://api-na.hosted.exlibrisgroup.com/almaws/v1/bibs/123456789/holdings/987654321/items/567890123/requests?apikey={your_api_key}
Content-Type: application/json

{
  "user_primary_id": "patron123",
  "request_type": "HOLD",
  "pickup_location_type": "LIBRARY",
  "pickup_location_library": "Main Library",
  "comment": "Requesting for research purposes."
}

For more details on creating a request for an item, refer to Create request for an Item

...

  • 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?

...