Tech Blog

Working with the code tables API

The GET /almaws/v1/conf/code-tables/{codeTableName} API gives the ability to retrieve list of rows from a code table. The list of rows contains for each row a code and its related description.

The main usage of this API is for applications that use Alma APIs, and need to give the user a drop-down of valid values to choose from.

For example, let’s assume I am writing a user management application. In this application I am using the Alma users API. I want to create a form for adding a new user. The form will display the fields, and after the user fills it and submits the form, the POST user API will be used.

You can see in the user object documentation that there are fields with a limited list of possible values. These values are usually defined in a code table:

In my application, I should use the GET /almaws/v1/conf/code-tables/{codeTableName} API in order to retrieve the list of possible values and display them as a drop-down on my form.

The relevant code table name can be found in the documentation:

And also in the xsd itself, in the annotation – appinfo – codeTable tag of the relevant field:

So in my application I will use In my application, I should use GET /almaws/v1/conf/code-tables/UserGroups. Example for calling the API from the API console:

Please Note that starting from the June release, the Alma code tables UI, will include both the table name and the table code. The table code should be used as a path parameter in the code tables API:

3 Replies to “Working with the code tables API”

  1. We too require an writable code tables API, especially for keeping user statistics like University departments and majors up-to-date. The alternative is manual entry, one by one, on the web interface as University department names and majors change. We need a pure systematic approach instead of human cognizance of every change at the University, then manual management of the table…

    By University of North Carolina at Charlotte 01UNCC_INST on September 27, 2017 at 4:27 PM

Leave a Reply