Tech Blog

How to use an API to retrieve the item Receiving number Weeding number and Weeding date in five easy steps

In the example here we will use an API to retrieve the item Receiving number, Weeding number and Weeding date.

These fields will be present in the item recorded only if the relevant sequences are defined.  They and are not used by all institutions.

See Configuring Physical Item Sequences for more information about the Receiving number, Weeding number and Weeding date.

ONE

Take note that we will be using the “Retrieve Item and label printing information” API.  You can learn more about in the list of Bibliographic records and Inventory APIs.

TWO

Identify an item which has the item Receiving number, Weeding number and Weeding date so that in your test you can confirm that it is being retrieved.  In our case item ID 2339739330000121, which is one item of title ” Theories in library science in the early French renaissance: the true story / by Elia Zafrani” has all three fields:

Receiving Number “REC-365”, Weeding Number “WEED-248” and Weeding Date “18/07/2019”:

THREE

Identify the MMSID, Holdings ID and Item ID of the item(s) you wish to retrieve. We will need these fields because they are required in the Retrieve Item and label printing information API, as described in the list of Bibliographic records and Inventory APIs :

You can identify the MMSID, Holdings ID and Item ID of the item(s) by looking in the Alma User interface, by using other APIs, or via an Alma Analytics report.  Here for example is the ctiretia tab of an Alma Analytics report getting the MMSID, Holdings ID and Item ID of the item(s):

Here are the results:

FOUR

Construct the API as follows as described here. (replace 01234567890 with real API key)

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/bibs/{MMSID}/holdings/{Holding ID}/items/{Item ID}?apikey=01234567890

for example:

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/bibs/99156911200121/holdings/2239739350000121/items/2339739330000121?apikey=01234567890

The API key will need at least “Read Only” permission for Bibs:

 

FIVE

Run the API and see the Receiving number, Weeding number and Weeding date

Leave a Reply