Skip to main content
  • Subscribe by RSS
  • ExLibris Dev

    British Library Document Supply Service (BLDSS)

    The British Library Document Supply Service (BLDSS) APIs create a seamless integration between your library and the British Library for resource sharing. The APIs are integrated into Alma's resource sharing and allow for all of the actions that are part of the process of requesting British Library material to be performed from within Alma as part of Alma's internal workflows. 

    British Library Online Account Setup

    To set up your British Library online account:
    1. To request the API, you need to know your British Library Business Account number (Customer Code), for example, 87-1234, and your Authorisation Code (ART Password) , for example, A1B2C34. If you do not know your Authorisation Code, use the following procedure to retrieve it:
      1. Access Business Account Administration: Login requires an Administrator or Account Manager role. If you do not have a personal login for On Demand, create one using the register link at: To obtain the necessary role to confirm the API, contact your Account Manager if you have one, or British Library Customer Services if you don’t.
      2. Click View/Change next to the required account.
      3. In the On Demand Ordering Options tab, see the Authorisation Code at the bottom of the page:
        British Library Account Setup
    2. Contact Ex Libris Support to notify Ex Libris of your account number. Ex Libris Support notifies the library that the account is linked to Alma.
    3. Log in to application management: to confirm that Alma has been linked to the account. Alma appears in the list of applications to which the client is registered (such as AlmaExTestApp). Click the Created button. The button changes to Confirmed.
      Applications to Which the Client Is Registered

    Alma Configuration

    • Locate Profile - A locate profile of type BLDSS must be created. For more information, see Adding Locate Profiles.
      The Alma locate process communicates with the partner's server. If the communication process fails, the locate will still be considered a success, leaving the partner on the rota. When this happens, the record ID is not recorded so the send request process will fail. The resulting message is "Cannot send a request that was not located." Should this occur, manually re-run the locate from the action on the task list. If this problem happens repeatedly, contact Ex Libris support to adjust your timeout settings.
    • Partner Record - A partner record of type BLDSS must be create. For more information, see Resource Sharing Partners.

    Alma Workflow Components

    • Activate Job - Two jobs entitled Update BLDSS Requests are found in the Monitor Jobs scheduler. One or both of them must be activated in order to receive status updates from the British Library. The British Library system posts status updates on their server. The Update BLDSS Requests job retrieves the updates. If both jobs are activated, status retrieval will be done twice a day. 
    • BLDSS Facet - In addition to the Active Partner facet which allows you to select BLDSS to display only BLDSS requests, there is a facet to filter on a particular BLDSS status. The BLDSS statuses are independent of Alma statuses because they are the statuses supplied by the British Library.
      Borrowing Request Task List
    • BLDSS Renewals - An option exists on the British Library account setup to automatically renew loans. If this option has been selected, an outstanding loan will automatically receive a status update of Renew Requested. It is recommended that you use the Status facet and select all BLDSS loans with a Renew Requested status. Manually renew the loan using the Renew Requested action. The request status will change to Renewed by partner.Make sure the partner’s lending workflow profile includes Staff Renewal and does not include Renewal Response.
    For more information about the BLDSS APIs, see More information About Using BLDSS APIs.
    // feedback widged