Page Comparison

References

...

1. Alma operator-assigned blocks

2. System-assigned blocks (limits)

3. Overdue blocks due to an overdue item (punitive blocks)

Active patron blocks can be retrieved using the Alma User API > Get user details > user_blocks endpoint. Details can be found here.

...

block_type: code of user block type

...

Check for Patron Blocks

Endpoint:

GET /almaws/v1/users/{user_id}

Key Field:

• user_block: Provides details about active blocks on the user's account.

Example Request:

http
GET https://api-na.hosted.exlibrisgroup.com/almaws/v1/users/12345678?apikey={your_api_key}

Example Response:

json
{
  "primary_id": "12345678",
  "first_name": "John",
  "last_name": "Doe",
  "user_block": [
    {
      "block_type": "General",
      "description": "User has overdue items",
      "status": "Active"
    }
  ],
  "user_status": "Active"
}

Details can be found here.

Place Requests

Place request at lending agency

...

• 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

3. Create Item

   • Parameters:

     • Barcode

     • physical_material_type

     • policy: Interlibrary Loan

     • location?

...