CINXE.COM

Alma Documentation - Ex Libris Developer Network

<!DOCTYPE html><html lang="en-US"><head><meta charset="UTF-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><link media="all" href="https://developers.exlibrisgroup.com/wp-content/cache/autoptimize/css/autoptimize_3ee4ced754c62786c892d06d720d1c25.css" rel="stylesheet" /><style media="screen">@media only screen and (max-width:1080px){html{margin-top:0 !important}}</style><title>Alma Documentation - Ex Libris Developer Network</title><meta name="viewport" content="width=device-width, initial-scale=1"><meta name="format-detection" content="telephone=no"><link rel="shortcut icon" type="image/x-icon" href="https://developers.exlibrisgroup.com/wp-content/uploads/2018/10/favicon.ico"> <script type="text/javascript" id="wpuf-language-script">var error_str_obj = { 'required' : 'is required', 'mismatch' : 'does not match', 'validation' : 'is not valid' }</script> <meta name='robots' content='index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1' /><link rel="canonical" href="https://developers.exlibrisgroup.com/alma/" /><meta property="og:locale" content="en_US" /><meta property="og:type" content="article" /><meta property="og:title" content="Alma Documentation - Ex Libris Developer Network" /><meta property="og:url" content="https://developers.exlibrisgroup.com/alma/" /><meta property="og:site_name" content="Ex Libris Developer Network" /><meta property="article:modified_time" content="2019-02-10T07:11:36+00:00" /><meta name="twitter:card" content="summary_large_image" /> <script type="application/ld+json" class="yoast-schema-graph">{"@context":"https://schema.org","@graph":[{"@type":"WebPage","@id":"https://developers.exlibrisgroup.com/alma/","url":"https://developers.exlibrisgroup.com/alma/","name":"Alma Documentation - Ex Libris Developer Network","isPartOf":{"@id":"https://developers.exlibrisgroup.com/#website"},"datePublished":"2018-10-23T19:18:44+00:00","dateModified":"2019-02-10T07:11:36+00:00","breadcrumb":{"@id":"https://developers.exlibrisgroup.com/alma/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https://developers.exlibrisgroup.com/alma/"]}]},{"@type":"BreadcrumbList","@id":"https://developers.exlibrisgroup.com/alma/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https://developers.exlibrisgroup.com/"},{"@type":"ListItem","position":2,"name":"Alma Documentation"}]},{"@type":"WebSite","@id":"https://developers.exlibrisgroup.com/#website","url":"https://developers.exlibrisgroup.com/","name":"Ex Libris Developer Network","description":"Ex Libris Developer Network","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https://developers.exlibrisgroup.com/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"}]}</script> <link href='https://fonts.gstatic.com' crossorigin='anonymous' rel='preconnect' /><link rel="alternate" type="application/rss+xml" title="Ex Libris Developer Network &raquo; Feed" href="https://developers.exlibrisgroup.com/feed/" /><link rel="alternate" type="application/rss+xml" title="Ex Libris Developer Network &raquo; Comments Feed" href="https://developers.exlibrisgroup.com/comments/feed/" /> <script type='text/javascript' src='https://developers.exlibrisgroup.com/wp-includes/js/jquery/jquery.min.js' id='jquery-core-js'></script> <script type='text/javascript' id='wpuf-ajax-script-js-extra'>var ajax_object = {"ajaxurl":"https:\/\/developers.exlibrisgroup.com\/wp-admin\/admin-ajax.php","fill_notice":"Some Required Fields are not filled!"};</script> <script type='text/javascript' src='https://developers.exlibrisgroup.com/wp-includes/js/dist/vendor/regenerator-runtime.min.js' id='regenerator-runtime-js'></script> <script type='text/javascript' src='https://developers.exlibrisgroup.com/wp-includes/js/dist/vendor/wp-polyfill.min.js' id='wp-polyfill-js'></script> <script type='text/javascript' src='https://developers.exlibrisgroup.com/wp-includes/js/dist/dom-ready.min.js' id='wp-dom-ready-js'></script> <script type='text/javascript' src='https://developers.exlibrisgroup.com/wp-includes/js/dist/hooks.min.js' id='wp-hooks-js'></script> <script type='text/javascript' src='https://developers.exlibrisgroup.com/wp-includes/js/dist/i18n.min.js' id='wp-i18n-js'></script> <script type='text/javascript' id='wp-i18n-js-after'>wp.i18n.setLocaleData( { 'text direction\u0004ltr': [ 'ltr' ] } );</script> <script type='text/javascript' src='https://developers.exlibrisgroup.com/wp-includes/js/dist/a11y.min.js' id='wp-a11y-js'></script> <script type='text/javascript' id='plupload-handlers-js-extra'>var pluploadL10n = {"queue_limit_exceeded":"You have attempted to queue too many files.","file_exceeds_size_limit":"%s exceeds the maximum upload size for this site.","zero_byte_file":"This file is empty. Please try another.","invalid_filetype":"Sorry, you are not allowed to upload this file type.","not_an_image":"This file is not an image. Please try another.","image_memory_exceeded":"Memory exceeded. Please try another smaller file.","image_dimensions_exceeded":"This is larger than the maximum size. Please try another.","default_error":"An error occurred in the upload. Please try again later.","missing_upload_url":"There was a configuration error. Please contact the server administrator.","upload_limit_exceeded":"You may only upload 1 file.","http_error":"Unexpected response from the server. The file may have been uploaded successfully. Check in the Media Library or reload the page.","http_error_image":"The server cannot process the image. This can happen if the server is busy or does not have enough resources to complete the task. Uploading a smaller image may help. Suggested maximum size is 2560 pixels.","upload_failed":"Upload failed.","big_upload_failed":"Please try uploading this file with the %1$sbrowser uploader%2$s.","big_upload_queued":"%s exceeds the maximum upload size for the multi-file uploader when used in your browser.","io_error":"IO error.","security_error":"Security error.","file_cancelled":"File canceled.","upload_stopped":"Upload stopped.","dismiss":"Dismiss","crunching":"Crunching\u2026","deleted":"moved to the Trash.","error_uploading":"\u201c%s\u201d has failed to upload.","unsupported_image":"This image cannot be displayed in a web browser. For best results convert it to JPEG before uploading.","noneditable_image":"This image cannot be processed by the web server. Convert it to JPEG or PNG before uploading.","file_url_copied":"The file URL has been copied to your clipboard"};</script> <script type='text/javascript' id='wpuf-upload-js-extra'>var wpuf_frontend_upload = {"confirmMsg":"Are you sure?","delete_it":"Yes, delete it","cancel_it":"No, cancel it","nonce":"ce1b87d3bc","ajaxurl":"https:\/\/developers.exlibrisgroup.com\/wp-admin\/admin-ajax.php","max_filesize":"8M","plupload":{"url":"https:\/\/developers.exlibrisgroup.com\/wp-admin\/admin-ajax.php?nonce=e23c04e265","flash_swf_url":"https:\/\/developers.exlibrisgroup.com\/wp-includes\/js\/plupload\/plupload.flash.swf","filters":[{"title":"Allowed Files","extensions":"*"}],"multipart":true,"urlstream_upload":true,"warning":"Maximum number of files reached!","size_error":"The file you have uploaded exceeds the file size limit. Please try again.","type_error":"You have uploaded an incorrect file type. Please try again."}};</script> <script type='text/javascript' id='wpuf-form-js-extra'>var wpuf_frontend = {"ajaxurl":"https:\/\/developers.exlibrisgroup.com\/wp-admin\/admin-ajax.php","error_message":"Please fix the errors to proceed","nonce":"ce1b87d3bc","cancelSubMsg":"Are you sure you want to cancel your current subscription ?","delete_it":"Yes","cancel_it":"No","char_max":"Character limit reached","char_min":"Minimum character required ","word_max":"Word limit reached","word_min":"Minimum word required ","coupon_error":"Please enter a coupon code!"};</script> <script type='text/javascript' id='wp-disable-css-lazy-load-js-extra'>var WpDisableAsyncLinks = {"wp-disable-font-awesome":"https:\/\/developers.exlibrisgroup.com\/wp-content\/themes\/exlibris-developers\/assets\/css\/font-awesome.min.css"};</script> <link rel="alternate" type="application/json+oembed" href="https://developers.exlibrisgroup.com/wp-json/oembed/1.0/embed?url=https%3A%2F%2Fdevelopers.exlibrisgroup.com%2Falma%2F" /><link rel="alternate" type="text/xml+oembed" href="https://developers.exlibrisgroup.com/wp-json/oembed/1.0/embed?url=https%3A%2F%2Fdevelopers.exlibrisgroup.com%2Falma%2F&#038;format=xml" /> <script type="text/javascript">jQuery(document).ready(function(){ jQuery('img[usemap]').rwdImageMaps(); });</script> <meta name="framework" content="Redux 4.3.9" /> <!--[if lt IE 9]> <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> <![endif]--><link rel="alternate" type="application/rss+xml" title="Ex Libris Developer Network Feed" href="https://developers.exlibrisgroup.com/feed/"> <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-N4K5Z46');</script> <meta name="google-site-verification" content="6Jq4vSpnrnahfTt299rynYtQJs1Z9H94BTln6-3ZPWg" /></head><body class="page-template page-template-templates page-template-template-product page-template-templatestemplate-product-php page page-id-511 page-parent locale-en-us"><script type="text/javascript"> (function() { var z="";var b="2866756e6374696f6e2829207b0d0a2066756e6374696f6e2067657453657373696f6e436f6f6b6965732829207b0d0a0976617220636f6f6b69654172726179203d206e657720417272617928293b0d0a0976617220634e616d65203d206e65772052656745787028275e5c5c733f696e6361705f7365735f27293b0d0a097661722063203d20646f63756d656e742e636f6f6b69652e73706c697428223b22293b0d0a09666f7220287661722069203d20303b2069203c20632e6c656e6774683b20692b2b29207b0d0a0909766172206b6579203d20635b695d2e73756273747228302c20635b695d2e696e6465784f6628223d2229293b0d0a09097661722076616c7565203d20635b695d2e73756273747228635b695d2e696e6465784f6628223d2229202b20312c20635b695d2e6c656e677468293b0d0a090969662028634e616d652e74657374286b65792929207b0d0a090909636f6f6b696541727261795b636f6f6b696541727261792e6c656e6774685d203d2076616c75653b0d0a09097d0d0a097d0d0a0972657475726e20636f6f6b696541727261793b0d0a207d0d0a2066756e6374696f6e20736574496e636170436f6f6b69652876417272617929207b0d0a09766172207265733b0d0a09747279207b0d0a090976617220636f6f6b696573203d2067657453657373696f6e436f6f6b69657328293b0d0a09097661722064696765737473203d206e657720417272617928636f6f6b6965732e6c656e677468293b0d0a0909666f7220287661722069203d20303b2069203c20636f6f6b6965732e6c656e6774683b20692b2b29207b0d0a090909646967657374735b695d203d2073696d706c6544696765737428764172726179202b20636f6f6b6965735b695d293b0d0a09097d0d0a0909726573203d20764172726179202b20222c6469676573743d22202b20646967657374732e6a6f696e28293b0d0a097d20636174636820286529207b0d0a0909726573203d20764172726179202b20222c6469676573743d22202b20656e636f6465555249436f6d706f6e656e7428652e746f537472696e672829293b0d0a097d0d0a09637265617465436f6f6b696528225f5f5f75746d7663222c207265732c203230293b0d0a207d0d0a2066756e6374696f6e2073696d706c65446967657374286d7973747229207b0d0a0976617220726573203d20303b0d0a09666f7220287661722069203d20303b2069203c206d797374722e6c656e6774683b20692b2b29207b0d0a0909726573202b3d206d797374722e63686172436f646541742869293b0d0a097d0d0a0972657475726e207265733b0d0a207d0d0a2066756e6374696f6e20637265617465436f6f6b6965286e616d652c2076616c75652c207365636f6e647329207b0d0a097661722065787069726573203d2022223b0d0a09696620287365636f6e647329207b0d0a09097661722064617465203d206e6577204461746528293b0d0a0909646174652e73657454696d6528646174652e67657454696d652829202b20287365636f6e6473202a203130303029293b0d0a09097661722065787069726573203d20223b20657870697265733d22202b20646174652e746f474d54537472696e6728293b0d0a097d0d0a09646f63756d656e742e636f6f6b6965203d206e616d65202b20223d22202b2076616c7565202b2065787069726573202b20223b20706174683d2f223b0d0a207d0d0a2066756e6374696f6e2074657374286f29207b0d0a0976617220726573203d2022223b0d0a0976617220764172726179203d206e657720417272617928293b0d0a09666f722028766172206a203d20303b206a203c206f2e6c656e6774683b206a2b2b29207b0d0a09207661722074657374203d206f5b6a5d5b305d3b0d0a092073776974636820286f5b6a5d5b315d29207b0d0a092009636173652022657869737473223a0d0a0909747279207b0d0a090909696628747970656f66286576616c2874657374292920213d3d2022756e646566696e656422297b0d0a090909097641727261795b7641727261792e6c656e6774685d203d20656e636f6465555249436f6d706f6e656e742874657374202b20223d7472756522293b0d0a0909097d0d0a090909656c73657b0d0a090909097641727261795b7641727261792e6c656e6774685d203d20656e636f6465555249436f6d706f6e656e742874657374202b20223d66616c736522293b0d0a0909097d0d0a09097d20636174636820286529207b0d0a0909097641727261795b7641727261792e6c656e6774685d203d20656e636f6465555249436f6d706f6e656e742874657374202b20223d66616c736522293b0d0a09097d0d0a0909627265616b3b0d0a090963617365202276616c7565223a0d0a09097472797b0d0a090909747279207b0d0a09090909726573203d206576616c2874657374293b0d0a09090909696628747970656f662872657329203d3d3d2022756e646566696e656422297b0d0a09090909097641727261795b7641727261792e6c656e6774685d203d20656e636f6465555249436f6d706f6e656e742874657374202b20223d756e646566696e656422293b0d0a090909097d0d0a09090909656c736520696628726573203d3d3d206e756c6c297b0d0a09090909097641727261795b7641727261792e6c656e6774685d203d20656e636f6465555249436f6d706f6e656e742874657374202b20223d6e756c6c22293b0d0a090909097d0d0a09090909656c7365207b0d0a09090909097641727261795b7641727261792e6c656e6774685d203d20656e636f6465555249436f6d706f6e656e742874657374202b20223d22202b207265732e746f537472696e672829293b0d0a090909097d0909090d0a0909097d20636174636820286529207b0d0a090909097641727261795b7641727261792e6c656e6774685d203d20656e636f6465555249436f6d706f6e656e742874657374202b20223d63616e6e6f74206576616c7561746522293b0d0a09090909627265616b3b0d0a0909097d0d0a090909627265616b3b0d0a09097d0d0a0909636174636820286529207b0d0a0909097641727261795b7641727261792e6c656e6774685d203d20656e636f6465555249436f6d706f6e656e742874657374202b20223d22202b2065293b0d0a09097d0d0a0909627265616b3b0d0a0909636173652022706c7567696e5f657874656e74696f6e73223a0d0a0909747279207b0d0a09090976617220657874656e74696f6e73203d205b5d3b0d0a090909747279207b0d0a0909090969203d20657874656e74696f6e732e696e6465784f6628226922293b0d0a0909097d20636174636820286529207b0d0a090909097641727261795b7641727261792e6c656e6774685d203d20656e636f6465555249436f6d706f6e656e742822706c7567696e5f6578743d696e6465784f66206973206e6f7420612066756e6374696f6e22293b0d0a09090909627265616b3b0d0a0909097d0d0a090909747279207b0d0a09090909766172206e756d203d206e6176696761746f722e706c7567696e732e6c656e6774683b0d0a09090909696620286e756d203d3d2030207c7c206e756d203d3d206e756c6c29207b0d0a09090909097641727261795b7641727261792e6c656e6774685d203d20656e636f6465555249436f6d706f6e656e742822706c7567696e5f6578743d6e6f20706c7567696e7322293b0d0a0909090909627265616b3b0d0a090909097d0d0a0909097d20636174636820286529207b0d0a090909097641727261795b7641727261792e6c656e6774685d203d20656e636f6465555249436f6d706f6e656e742822706c7567696e5f6578743d63616e6e6f74206576616c7561746522293b0d0a09090909627265616b3b0d0a0909097d0d0a0909090d0a090909666f72202876617220693d303b693c6e6176696761746f722e706c7567696e732e6c656e6774683b692b2b29207b0d0a0909090969662028747970656f66286e6176696761746f722e706c7567696e735b695d29203d3d3d2022756e646566696e65642229207b0d0a09090909097641727261795b7641727261792e6c656e6774685d203d20656e636f6465555249436f6d706f6e656e742822706c7567696e5f6578743d706c7567696e735b695d20697320756e646566696e656422293b0d0a0909090909627265616b3b0d0a090909097d0d0a0d0a090909097661722066696c656e616d65203d206e6176696761746f722e706c7567696e735b695d2e66696c656e616d653b0d0a0909090976617220657874203d20226e6f20657874656e74696f6e223b0d0a0909090969662028747970656f662866696c656e616d6529203d3d3d2022756e646566696e65642229207b0d0a0909090909657874203d202266696c656e616d6520697320756e646566696e6564223b0d0a090909097d0d0a09090909656c7365206966202866696c656e616d652e73706c697428222e22292e6c656e677468203e203129207b0d0a0909090909657874203d2066696c656e616d652e73706c697428272e27292e706f7028293b0d0a090909097d0d0a0d0a0909090969662028657874656e74696f6e732e696e6465784f662865787429203c203029207b0d0a0909090909657874656e74696f6e732e7075736828657874293b0d0a090909097d090d0a0909097d0d0a0909090d0a090909666f7209287661722069203d20303b2069203c20657874656e74696f6e732e6c656e6774683b20692b2b29207b0d0a090909097641727261795b7641727261792e6c656e6774685d203d20656e636f6465555249436f6d706f6e656e742822706c7567696e5f6578743d22202b20657874656e74696f6e735b695d293b0d0a0909097d0d0a09097d0d0a0909636174636820286529207b0d0a0909097641727261795b7641727261792e6c656e6774685d203d20656e636f6465555249436f6d706f6e656e742822706c7567696e5f6578743d22202b2065293b0d0a09097d0d0a0909627265616b3b0d0a09207d0d0a097d0d0a0972657475726e207641727261792e6a6f696e28293b0d0a207d0d0a20766172206f203d205b0d0a095b226e6176696761746f72222c2022657869737473225d2c0d0a095b226e6176696761746f722e76656e646f72222c202276616c7565225d2c0d0a095b226e6176696761746f722e6170704e616d65222c202276616c7565225d2c0d0a095b226e6176696761746f722e706c7567696e732e6c656e6774683d3d30222c202276616c7565225d2c0d0a095b226e6176696761746f722e706c6174666f726d222c202276616c7565225d2c0d0a095b226e6176696761746f722e776562647269766572222c202276616c7565225d2c0d0a095b22706c6174666f726d222c2022706c7567696e5f657874656e74696f6e73225d2c0d0a095b22416374697665584f626a656374222c2022657869737473225d2c0d0a095b227765626b697455524c222c2022657869737473225d2c0d0a095b225f7068616e746f6d222c2022657869737473225d2c0d0a095b2263616c6c5068616e746f6d222c2022657869737473225d2c0d0a095b226368726f6d65222c2022657869737473225d2c0d0a095b2279616e646578222c2022657869737473225d2c0d0a095b226f70657261222c2022657869737473225d2c0d0a095b226f7072222c2022657869737473225d2c0d0a095b22736166617269222c2022657869737473225d2c0d0a095b22617765736f6d69756d222c2022657869737473225d2c0d0a095b2270756666696e446576696365222c2022657869737473225d2c0d0a095b225f5f6e696768746d617265222c2022657869737473225d2c0d0a095b22646f6d4175746f6d6174696f6e222c2022657869737473225d2c0d0a095b22646f6d4175746f6d6174696f6e436f6e74726f6c6c6572222c2022657869737473225d2c0d0a095b225f53656c656e69756d5f4944455f5265636f72646572222c2022657869737473225d2c0d0a095b22646f63756d656e742e5f5f7765626472697665725f7363726970745f666e222c2022657869737473225d2c0d0a095b22646f63756d656e742e246364635f6173646a666c617375746f70666876635a4c6d63666c5f222c2022657869737473225d2c0d0a095b2270726f636573732e76657273696f6e222c2022657869737473225d2c0d0a095b226e6176696761746f722e637075436c617373222c2022657869737473225d2c0d0a095b226e6176696761746f722e6f73637075222c2022657869737473225d2c0d0a095b226e6176696761746f722e636f6e6e656374696f6e222c2022657869737473225d2c0d0a095b226e6176696761746f722e6c616e67756167653d3d274327222c202276616c7565225d2c0d0a095b2277696e646f772e6f7574657257696474683d3d30222c202276616c7565225d2c0d0a095b2277696e646f772e6f757465724865696768743d3d30222c202276616c7565225d2c0d0a095b2277696e646f772e576562474c52656e646572696e67436f6e74657874222c2022657869737473225d2c0d0a095b22646f63756d656e742e646f63756d656e744d6f6465222c202276616c7565225d2c0d0a095b226576616c2e746f537472696e6728292e6c656e677468222c202276616c7565225d0d0a5d3b0d0a20747279207b0d0a09736574496e636170436f6f6b69652874657374286f29293b0d0a09646f63756d656e742e637265617465456c656d656e742822696d6722292e737263203d20222f5f496e63617073756c615f5265736f757263653f53574b4d544653523d3126653d22202b204d6174682e72616e646f6d28293b0d0a207d20636174636820286529207b0d0a09696d67203d20646f63756d656e742e637265617465456c656d656e742822696d6722293b0d0a09696d672e737263203d20222f5f496e63617073756c615f5265736f757263653f53574b4d544653523d3126653d22202b20653b0d0a207d0d0a7d2928293b0d0a";eval((function(){for (var i=0;i<b.length;i+=2){z+=String.fromCharCode(parseInt(b.substring(i,i+2),16));} return z;})());})(); </script><header id="header" class="headroom"><div class="mini_top_nav"><div class="custom-container"><nav id="mini-site-navigation"><ul id="menu-top" class="sf-menu sf-navbar"><li id="menu-item-15" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-15"><a href="/about">New Here?</a></li><li id="menu-item-66983" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-66983"><a href="/cloudapps/">Cloud Apps</a></li><li id="menu-item-3717" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-3717"><a href="/console">API Console</a></li><li id="menu-item-16" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-16"><a href="/about/standards">Standards</a></li><li class="search"><form role="search" method="get" class="search-form" action="https://developers.exlibrisgroup.com/"> <button type="submit" class="search-submit"><i class="fa fa-search" aria-hidden="true"></i></button> <input type="text" class="field" name="s" id="s" value="" placeholder="Search" /></form></li><li class="with-arrow"><a target="_blank" href="https://www.exlibrisgroup.com/">Go to exlibrisgroup.com</a></li><li class="pre-last"><a href="https://developers.exlibrisgroup.com/login/">Login</a></li><li class="last"><a href="https://developers.exlibrisgroup.com/account/register/">Signup</a></li></ul></nav></div></div><div class="top_nav"><div class="custom-container"><div class="logo"> <a class="main " href="https://developers.exlibrisgroup.com"><noscript><img src="https://developers.exlibrisgroup.com/wp-content/uploads/2018/10/exdev-logo-clarivate.png" alt="Logo"></noscript><img class="lazyload" src='data:image/svg+xml,%3Csvg%20xmlns=%22http://www.w3.org/2000/svg%22%20viewBox=%220%200%20210%20140%22%3E%3C/svg%3E' data-src="https://developers.exlibrisgroup.com/wp-content/uploads/2018/10/exdev-logo-clarivate.png" alt="Logo"></a></div><nav id="site-navigation"><ul id="menu-main" class="sf-menu sf-navbar"><li id="menu-item-52" class="menu-item menu-item-type-custom menu-item-object-custom current-menu-ancestor current-menu-parent menu-item-has-children menu-item-52"><a href="#"><span>Learn</span>Documentation</a><ul class="sub-menu"><li id="menu-item-56" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-56"><a href="/primo">Primo</a></li><li id="menu-item-57" class="menu-item menu-item-type-custom menu-item-object-custom current-menu-item menu-item-57"><a href="/alma" aria-current="page">Alma</a></li><li id="menu-item-490" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-490"><a href="/summon">Summon</a></li><li id="menu-item-66206" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-66206"><a href="/Esploro">Esploro</a></li><li id="menu-item-59" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-59"><a href="/leganto">Leganto</a></li><li id="menu-item-496" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-496"><a href="/campusm">campusM</a></li><li id="menu-item-68744" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-68744"><a href="/rapido">Rapido</a></li><li id="menu-item-58" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-58"><a href="/rosetta">Rosetta</a></li><li id="menu-item-493" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-493"><a href="/sfx">SFX</a></li><li id="menu-item-494" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-494"><a href="/aleph">Aleph</a></li><li id="menu-item-495" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-495"><a href="/voyager">Voyager</a></li><li id="menu-item-491" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-491"><a href="/bx">bX</a></li><li id="menu-item-492" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-492"><a href="/metalib">MetaLib</a></li><li id="menu-item-497" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-497"><a href="/digitool">DigiTool</a></li><li id="menu-item-3822" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-3822"><a href="/ulrichsweb">Ulrichsweb</a></li><li id="menu-item-498" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-498"><a href="/verde">Verde</a></li><li id="menu-item-52774" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-52774"><a href="/360-services">360/Intota</a></li></ul></li><li id="menu-item-2214" class="menu-item menu-item-type-post_type menu-item-object-page menu-item-2214"><a href="https://developers.exlibrisgroup.com/manage/"><span>Build</span>My APIs</a></li><li id="menu-item-400" class="menu-item menu-item-type-post_type menu-item-object-page menu-item-400"><a href="https://developers.exlibrisgroup.com/blog/"><span>Share</span>Blog</a></li><li id="menu-item-2227" class="menu-item menu-item-type-post_type menu-item-object-page menu-item-2227"><a href="https://developers.exlibrisgroup.com/forum/"><span>Ask</span>Forum</a></li><li id="menu-item-52156" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-52156"><a href="/appcenter/"><span>Discover</span>App Center</a></li></ul></nav></div></div></header><div class="mobile-header headroom" id="mobile-header-headroom"><div class="pie"> <span class="icon-bar first"></span> <span class="icon-bar second"></span> <span class="icon-bar third"></span></div><div class="logo"> <a class="main" href="https://developers.exlibrisgroup.com"> <noscript><img src="https://developers.exlibrisgroup.com/wp-content/uploads/2018/10/exdev-logo-clarivate.png" alt="Logo"></noscript><img class="lazyload" src='data:image/svg+xml,%3Csvg%20xmlns=%22http://www.w3.org/2000/svg%22%20viewBox=%220%200%20210%20140%22%3E%3C/svg%3E' data-src="https://developers.exlibrisgroup.com/wp-content/uploads/2018/10/exdev-logo-clarivate.png" alt="Logo"> </a> <a class="small" style="display:none;" href="https://developers.exlibrisgroup.com"><noscript><img src="" alt="Logo"></noscript><img class="lazyload" src='data:image/svg+xml,%3Csvg%20xmlns=%22http://www.w3.org/2000/svg%22%20viewBox=%220%200%20210%20140%22%3E%3C/svg%3E' data-src="" alt="Logo"></a></div><nav id="mobile-site-navigation"><ul id="menu-mobile" class="sf-menu sf-navbar mm-0"><li id="menu-item-1406" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-1406"><a href="/">Home</a></li><li id="menu-item-1385" class="menu-item menu-item-type-custom menu-item-object-custom current-menu-ancestor current-menu-parent menu-item-has-children menu-item-1385"><a href="#">Documentation</a><span class="arrow"><i class="fa fa-angle-down" aria-hidden="true"></i></span><ul class="sub-menu"><li id="menu-item-1386" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-1386"><a href="/primo">Primo</a></li><li id="menu-item-1388" class="menu-item menu-item-type-custom menu-item-object-custom current-menu-item menu-item-1388"><a href="/alma" aria-current="page">Alma</a></li><li id="menu-item-1396" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-1396"><a href="/summon">Summon</a></li><li id="menu-item-66205" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-66205"><a href="/Esploro">Esploro</a></li><li id="menu-item-1391" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-1391"><a href="/leganto">Leganto</a></li><li id="menu-item-1400" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-1400"><a href="/campusm">campusM</a></li><li id="menu-item-68743" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-68743"><a href="/rapido">Rapido</a></li><li id="menu-item-1389" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-1389"><a href="/rosetta">Rosetta</a></li><li id="menu-item-1395" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-1395"><a href="/sfx">SFX</a></li><li id="menu-item-1397" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-1397"><a href="/aleph">Aleph</a></li><li id="menu-item-1398" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-1398"><a href="/voyager">Voyager</a></li><li id="menu-item-1392" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-1392"><a href="/bx">bX</a></li><li id="menu-item-1393" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-1393"><a href="/metalib">MetaLib</a></li><li id="menu-item-1401" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-1401"><a href="/digitool">DigiTool</a></li><li id="menu-item-3823" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-3823"><a href="/ulrichsweb">Ulrichsweb</a></li><li id="menu-item-1402" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-1402"><a href="/verde">Verde</a></li><li id="menu-item-52772" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-52772"><a href="/360-services">360/Intota</a></li></ul></li><li id="menu-item-349" class="menu-item menu-item-type-post_type menu-item-object-page menu-item-349"><a href="https://developers.exlibrisgroup.com/manage/">My APIs</a></li><li id="menu-item-350" class="menu-item menu-item-type-post_type menu-item-object-page menu-item-350 current-menu-item"><a href="https://developers.exlibrisgroup.com/blog/">Blog</a></li><li id="menu-item-345" class="menu-item menu-item-type-post_type menu-item-object-page menu-item-345"><a href="https://developers.exlibrisgroup.com/forum/">Forum</a></li><li id="menu-item-66984" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-66984"><a href="/cloudapps/">Cloud Apps</a></li><li id="menu-item-52153" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-52153"><a href="/appcenter">App Center</a></li><li id="menu-item-1408" class="menu-item menu-item-type- menu-item-object-wpuf_login menu-item-1408"><a href="https://developers.exlibrisgroup.com/login/">Login</a></li></ul></nav></div><div class="page-content extra-padding"><div class="forum-title"><div class="custom-container"><h1>Alma Documentation</h1></div></div><div class="product-three-cubes"><div class="custom-container"><div class="row"><div class="col-md-4 col-sm-12"><div class="product-cube"><div class="main-title">REST <br/>APIs</div><div class="icon"><noscript><img src="https://developers.exlibrisgroup.com/wp-content/uploads/product-home-icons/product-apis.png" alt="Icon"></noscript><img class="lazyload" src='data:image/svg+xml,%3Csvg%20xmlns=%22http://www.w3.org/2000/svg%22%20viewBox=%220%200%20210%20140%22%3E%3C/svg%3E' data-src="https://developers.exlibrisgroup.com/wp-content/uploads/product-home-icons/product-apis.png" alt="Icon"></div><div class="content">Alma has hundreds of REST APIs which allow you to access your workflows and data programmatically.</div><div class="destination"><a class="" href="./apis">READ MORE</a></div></div></div><div class="col-md-4 col-sm-12"><div class="product-cube"><div class="main-title">Standards & Integrations</div><div class="icon"><noscript><img src="https://developers.exlibrisgroup.com/wp-content/uploads/product-home-icons/product-icon-1.png" alt="Icon"></noscript><img class="lazyload" src='data:image/svg+xml,%3Csvg%20xmlns=%22http://www.w3.org/2000/svg%22%20viewBox=%220%200%20210%20140%22%3E%3C/svg%3E' data-src="https://developers.exlibrisgroup.com/wp-content/uploads/product-home-icons/product-icon-1.png" alt="Icon"></div><div class="content">Alma is the backbone of your library, but it doesn't live in a vacuum. Alma was built to play well with others.</div><div class="destination"><a class="" href="./integrations">READ MORE</a></div></div></div><div class="col-md-4 col-sm-12"><div class="product-cube product-blog-cube"><div class="fixed-content"><div class="main-title">Alma <br> Tech Blog</div><div class="single-item"><div class="item-meta"> <span class="post-author">by Yoel Kortick</span> <span>November 27, 2024</span></div> <a href="https://developers.exlibrisgroup.com/blog/how-to-create-one-data-visualization-workbook-with-multiple-canvases/" class="title">How to Create One Data Visualization Workbook with Multiple Canvases</a></div><div class="single-item"><div class="item-meta"> <span class="post-author">by Shai Ben-Hur</span> <span>November 25, 2024</span></div> <a href="https://developers.exlibrisgroup.com/blog/library-open-workflow-master-the-essentials-for-a-solid-foundation/" class="title">Library Open Workflow – Master the Essentials for a Solid Foundation!</a></div><div class="single-item"><div class="item-meta"> <span class="post-author">by Yoel Kortick</span> <span>November 24, 2024</span></div> <a href="https://developers.exlibrisgroup.com/blog/how-to-use-an-api-to-retrieve-loans-of-a-specific-user-in-five-easy-steps/" class="title">How to use an API to retrieve loans of a specific user in five easy steps</a></div><div class="single-item"><div class="item-meta"> <span class="post-author">by Shai Ben-Hur</span> <span>November 14, 2024</span></div> <a href="https://developers.exlibrisgroup.com/blog/library-open-workflows-just-how-easy-is-it-very/" class="title">Library Open Workflows: Just How Easy Is It? Very!</a></div></div></div></div></div></div></div><div class="hp-two-cubes"><div class="col-md-6 col-sm-12 highlights"><div class="custom-container-half"><p class="highlights-title">Highlights</p><div id="carouselHighlightsHome" class="carousel slide home-slider" data-ride="carousel" data-interval="7000"><ol class="carousel-indicators"><li data-target="#carouselHighlightsHome" data-slide-to="0" class="active"></li><li data-target="#carouselHighlightsHome" data-slide-to="1" class=""></li></ol><div class="carousel-inner"><div class="item active"><p class="highlights-item-title">Finance integration APIs</p><p class="highlights-item-text">New APIs allow you to integrate with your institutional ERP system in real time.</p><div class="highlights-button"> <a href="/blog/Alma-ERP-invoices-integration-using-APIs">READ MORE</a></div></div><div class="item"><p class="highlights-item-title">Alma is talking webhooks</p><p class="highlights-item-text">With webhooks, you can configure Alma to send notifications to your apps when events happen.</p><div class="highlights-button"> <a href="/alma/integrations/webhooks">READ MORE</a></div></div></div><div class="clearfix"></div> <a class="carousel-control carousel-control-prev slider-link" href="#carouselHighlightsHome" role="button" data-slide="prev"> <i class="fa fa-chevron-left" aria-hidden="true"></i> <span class="sr-only">Previous</span> </a> <a class="carousel-control carousel-control-next slider-link" href="#carouselHighlightsHome" role="button" data-slide="next"> <i class="fa fa-chevron-right" aria-hidden="true"></i> <span class="sr-only">Next</span> </a></div></div></div><div class="col-md-6 col-sm-12 api-dashboard what-can-you"><div class="custom-container-half"><p class="highlights-title">What can you do?</p><div id="carouselCubes" class="carousel slide home-slider" data-ride="carousel" data-interval="7000"><ol class="carousel-indicators"><li data-target="#carouselCubes" data-slide-to="0" class="active"></li><li data-target="#carouselCubes" data-slide-to="1" class=""></li></ol><div class="carousel-inner"><div class="item active"><p class="highlights-item-title">Alma Digital Repository</p><p class="highlights-item-text">Did you know that Alma is a full-featured digital repository? See the latest blog entries here.</p><div class="highlights-button"> <a href="/blog/?tag=digital">CLICK FOR MORE</a></div></div><div class="item"><p class="highlights-item-title">Student Information Systems</p><p class="highlights-item-text">Synchronize users in Alma with your student information system via the file-based integration</p><div class="highlights-button"> <a href="/alma/integrations/user-management/sis">CLICK FOR MORE</a></div></div></div><div class="clearfix"></div> <a class="carousel-control carousel-control-prev slider-link" href="#carouselCubes" role="button" data-slide="prev"> <i class="fa fa-chevron-left" aria-hidden="true"></i> <span class="sr-only">Previous</span> </a> <a class="carousel-control carousel-control-next slider-link" href="#carouselCubes" role="button" data-slide="next"> <i class="fa fa-chevron-right" aria-hidden="true"></i> <span class="sr-only">Next</span> </a></div></div></div><div class="clearfix"></div></div></div><footer><div class="custom-container"> <a class="footer-logo" href="https://developers.exlibrisgroup.com"><noscript><img src="https://developers.exlibrisgroup.com/wp-content/uploads/2018/10/exldev-footer-logo-clarivate.png" alt="Logo"></noscript><img class="lazyload" src='data:image/svg+xml,%3Csvg%20xmlns=%22http://www.w3.org/2000/svg%22%20viewBox=%220%200%20210%20140%22%3E%3C/svg%3E' data-src="https://developers.exlibrisgroup.com/wp-content/uploads/2018/10/exldev-footer-logo-clarivate.png" alt="Logo"></a><div class="nav-menu-section"><nav id="footer-navigation"><ul id="menu-footer" class="sf-menu sf-navbar"><li id="menu-item-46" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-46"><a href="/about/terms">Terms of Use</a></li><li id="menu-item-48" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-48"><a href="https://trust.exlibrisgroup.com/">Trust Center</a></li><li id="menu-item-49" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-49"><a href="https://www.exlibrisgroup.com/privacy-policy/">Privacy</a></li></ul><div class="textwidget custom-html-widget">© Copyright Ex Libris Ltd. 2024<span>|</span>All Rights Reserved</div></nav></div><div class="social-icons"> <span>Follow Us</span><div class="textwidget custom-html-widget"><a class="tw" href="https://twitter.com/ExLibrisGroup" target="blank" rel="noopener"><i class="fa fa-twitter" aria-hidden="true"></i></a> <a class="fb" href="https://www.facebook.com/exlibrisgroup" target="blank" rel="noopener"><i class="fa fa-facebook" aria-hidden="true"></i></a> <a class="ln" href="https://www.linkedin.com/company/7746" target="blank" rel="noopener"><i class="fa fa-linkedin" aria-hidden="true"></i></a> <a class="youtube" href="https://www.youtube.com/user/ExLibrisLtd" target="blank" rel="noopener"><i class="fa fa-youtube" aria-hidden="true"></i></a></div></div></div></footer> <script type="text/javascript">var btlOpt = { SITE_URL :'https://developers.exlibrisgroup.com/', HOME_URL :'https://developers.exlibrisgroup.com/', BT_AJAX :'https://developers.exlibrisgroup.com/wp-admin/admin-ajax.php', }</script> <noscript><style>.lazyload{display:none;}</style></noscript><script data-noptimize="1">window.lazySizesConfig=window.lazySizesConfig||{};window.lazySizesConfig.loadMode=1;</script><script async data-noptimize="1" src='https://developers.exlibrisgroup.com/wp-content/plugins/autoptimize/classes/external/js/lazysizes.min.js?ao_version=3.1.3'></script> <script type='text/javascript' src='https://developers.exlibrisgroup.com/wp-content/plugins/enlighter/cache/enlighterjs.min.js' id='enlighterjs-js'></script> <script type='text/javascript' id='enlighterjs-js-after'>!function(e,n){if("undefined"!=typeof EnlighterJS){var o={"selectors":{"block":"pre.EnlighterJSRAW","inline":"code.EnlighterJSRAW"},"options":{"indent":2,"ampersandCleanup":true,"linehover":false,"rawcodeDbclick":true,"textOverflow":"break","linenumbers":false,"theme":"mowtwo","language":"generic","retainCssClasses":false,"collapse":false,"toolbarOuter":"","toolbarTop":"{BTN_RAW}{BTN_COPY}{BTN_WINDOW}{BTN_WEBSITE}","toolbarBottom":""}};(e.EnlighterJSINIT=function(){EnlighterJS.init(o.selectors.block,o.selectors.inline,o.options)})()}else{(n&&(n.error||n.log)||function(){})("Error: EnlighterJS resources not loaded yet!")}}(window,console);</script> <script type='text/javascript' id='jquery-ui-autocomplete-js-extra'>var uiAutocompleteL10n = {"noResults":"No results found.","oneResult":"1 result found. Use up and down arrow keys to navigate.","manyResults":"%d results found. Use up and down arrow keys to navigate.","itemSelected":"Item selected."};</script> <script type='text/javascript' id='wpuf-subscriptions-js-extra'>var wpuf_subscription = {"pack_notice":"Please Cancel Your Currently Active Pack first!"};</script> <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-N4K5Z46" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> <script defer src="https://developers.exlibrisgroup.com/wp-content/cache/autoptimize/js/autoptimize_920a95591daaac9af953e350f690fd3e.js"></script></body></html>

Pages: 1 2 3 4 5 6 7 8 9 10