Page Comparison

References

...

A virtual patron in Alma can be created by using the Rest user Create a User API. The mandatory fields for this API are as follows:

Endpoint

POST /almaws/v1/users

The minimum required fields are primary_id, first_name, last_name, and user_group.

• record_type:Public

• primary_id: The primary identifier of the userAccount

• first_name: User's first name.

• last_name: User's last name.

• account_type: External

• Useruser_group(optional): Used in fulfillment policieslast_name: Used in displays and search

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.

Endpoint

GET /almaws/v1/users/{user_id}

Parameters

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

...

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

...