Tech Blog

How to create a resource sharing partner of type ISO 18626 via an API in 5 easy steps

Avatarby Yoel Kortick Ex Libris November 17, 2019
ALMA GETTING-STARTED HOW-TO-APIS-IN-5-EASY-STEPS

This blog will focus on creating a resource sharing partner of type ISO 18626 via an API in your institution.
The developer network already discusses resource sharing partners.
See also in the developer network specifics regarding creating a partner.

Additionally, the developer network provides a generic sample input file for the resource sharing partner in both XML and JSON format.

However, this blog focuses on using an existing partner in your institution as a template, and not a generic sample. In this way you will have an example with, for example, your locate profile, borrowing workflow, lending workflow, etc.

ONE

Make sure you have an API key for read/write partners. If you do not have one then log into the developer network and create one.
Set to sandbox or production as desired.

TWO

Identify an existing resource sharing partner of type ISO 18626 similar to the one you want to create. This resource sharing partner of type ISO 18626 will be used as a “template” for the new resource sharing partner.  Here is the existing partner we will use:
Partner code: YILIS
Partner name: The YILIS Institute of Library and Information Science

THREE

Do a GET on the partner and save the XML (or JSON) in a local file for editing.
Here is the syntax (of course replace “01234567890” with your real API key):

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/partners/YILIS?apikey=01234567890

Here are the results of the GET.  Note the “profile_type” and “iso_18626_details”:

FOUR

Edit the output from the GET above as follows to use as input for the POST.  The POST will create the new resource sharing partner of type ISO 18626.

  • Change the partner code to one that does not already exist
  • Change the partner name to one that does not already exist
  • Change the iso_symbol to one that does not already exist.
  • Change anything else (for example the holding_code).

Our new partner will have:

  • Partner code: ALICIA
  • Partner name: The Alicia Institute of Library and Information Science
  • ISO Symbol: ALICIA-18626
  • Holding Code: ALICIA-H

FIVE

Do a POST as follows:

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/partners?apikey=01234567890

Here is the created partner in the Alma User Interface:

We can see that the values of the partner were created via the API:

Leave a Reply