Page Comparison

...

...

...

...

...

...

References

...

Additional:

• Implementing a DCB client adaptor

• From Contribution to Selectable

• Tracking v3 matrix

...

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

...

Retrieving Request Closure Status via API

Endpoint:

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

Example Request:

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:

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

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

...