Tech Blog

How to create and populate an itemized set via an API in 5 easy steps

In this blog post we will create an itemized set and add items to it using an API.

Note that in order to create and populate the itemized set you will need an API key for read write in the configuration area.

ONE

Create the itemized set using this API with POST

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/conf/sets?combine=None&set1=None&set2=None&apikey=01234567890

Here is the sample input (payload) to create the itemized set.  In the situation below it is a physical item set (content value = ITEM).  The process is similar for other types of sets.

<?xml version="1.0" encoding="UTF-8"?>
<set link="string">
  <name>Yoel's Koeln Set of Items</name>
  <description>Items from the holy city of Koeln</description>
  <type>
    <xml_value>ITEMIZED</xml_value>
  </type>
  <content>
    <xml_value>ITEM</xml_value>
  </content>
  <private>
    <xml_value>true</xml_value>
  </private>
  <status>
    <xml_value>ACTIVE</xml_value>
  </status>
  <note></note>
  <query>
    <xml_value></xml_value>
  </query>
</set>

TWO

Receive response that the set is created.  In the response we see that the set ID is 5979124090000121

THREE

See in Alma that the set is created.

Note also that the set ID is also present in the Alma user interface:

FOUR

Add members to the itemized set which has ID 5979124090000121.

Do a POST like this

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/conf/sets/5979124090000121?id_type=BARCODE&op=add_members&apikey=l7xxb1e0a1a10fdb4665ae8ae86a361eb6a5

The input (payload) appears as follows with list of items (barcodes) to add.

<?xml version="1.0" encoding="UTF-8"?>
<set link="string">
<members>
<member><id>AU44215</id></member>
<member><id>32651-10</id></member>
<member><id>AU45160</id></member>
<member><id>AU44976</id></member>
<member><id>AU44977</id></member>
<member><id>AU44969</id></member>
<member><id>AU44143</id></member>
<member><id>AU43934</id></member>
<member><id>AU44564</id></member>
<member><id>AU44565</id></member>
<member><id>AU44525</id></member>
<member><id>AU43960</id></member>
<member><id>AU43932</id></member>
<member><id>AU45231</id></member>
<member><id>AU44450</id></member>
<member><id>AU44978</id></member>
<member><id>AU43928</id></member>
<member><id>AU42755</id></member>
<member><id>AU44578</id></member>
<member><id>AU45157</id></member>
<member><id>AU45040</id></member>
<member><id>AU44145</id></member>
<member><id>AU45031</id></member>		
</members>
</set>

Receive response with number of members added:

FIVE

See in Alma that the records have been added to the set

Leave a Reply