Page Comparison

References

...

For more details on creating a user, refer to Create user

...

Search for a user in Alma

Retrieve User API allows to look up a user by their primary ID, barcode, or email address.

...

1. user_id: The user's unique identifier in Alma. This can be their primary ID, barcode, or email address.

2. apikey: Your API key with appropriate permissions.

...

Creating an item-level request in Alma

...

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."
}

...

A virtual item in Alma can be created by using the following APIs:

1. Create an Item API allows to add an item to a specific bibliographic record and holding

• Mandatory Fields:

  • The actual record: XML string describing the record

  • record_format: Default is marc21

  • suppress_from_publishing: default is true

2. Create holding record

Endpoint

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

Required Parameters:

...

• mms_id:

  Bib record ID

• Mandatory Fields:

  • The actual record: XML string describing the record

  • suppress_from_publishing: tbd

Create Item

• The unique identifier of the bibliographic record.

• holding_id: The ID of the holding record where the item will be added.

Key Fields:

• Barcode

• physical_material_type

• policy: Interlibrary Loan

• location?

...

Creating an item-level request

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.

  • User_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.

...

• : The item's shelving location

• library: The library where the item is located.

Example request:

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

{
  "item_data": {
    "barcode": "1234567890123",
    "policy": "Standard Loan",
    "library": {
      "value": "MAIN"
    },
    "location": {
      "value": "GEN"
    },
    "physical_material_type": {
      "value": "BOOK"
    },
    "description": "Hardcover edition",
    "enumeration_a": "Vol. 1"
  }
}

Notes:

• Barcodes must be unique across Alma. If the barcode already exists, the request will fail

• Library and location codes must match valid configurations in Alma.

• The mms_id and holding_id should correspond to existing records.

For more details on creating an item, refer to Create Item.

...

2. Create a Bibliographic Record API

API Endpoint

POST /almaws/v1/bibs

Key Fields:

• The MARC XML structure should follow the standard MARC21 format.

• suppress_from_publishing: default is true

For more details on creating a bibliographic record, refer to Create record

...

3. Create a Holding Record API

API Endpoint

POST /almaws/v1/bibs/{mms_id}/holdings

Parameters:

• mms_id: Bib record ID

Key Fields:

• The actual record: XML string describing the record

  • suppress_from_publishing: tbd

For more details on creating a holding record, refer to Create holding record

...

Circulate Requests

Circulation tracking and reaction (lending)

...