Skip to main content
ExLibris
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    Retrieve Attendees

    Overview

    The Retrieve Attendees product integration allows lecturers to get a list of students who attend a specific event.

    Vendors

    Retrieve Attendees is currently supported by the RESTful API vendor.

    User Experience

    The following section describes information relating to the user experience for the Retrieve Attendees product integration.

    User Activities

    Staff users can choose to view a list of students who attend a specific event and confirm their attendance.

    User Workflow Diagram

    The following diagram illustrates the user workflow:

    retrieve_attendees_userflow diagram.png

    Retrieve Attendees User Flow Diagram

    Authentication

    Users of the Retrieve Attendees product integration are authenticated by the CMAuth authentication token, so that no separate login is required.

    Offline Support

    There is no offline support.

    Screenshots

    The following is an overview of the Retrieve Attendees product integration user interface for a reference when configuring it:

    Option I: Attendance Check-in tab - clicking Check-in Students Attendees List of the Event:
    retrieve_attendees_image1.png retrieve_attendees_image2.png
    Option II: Attendance History Tab: Attendees List of the event after the Retrieve Attendees
    product integration is triggered:
    retrieve_attendees_image3.png retrieve_attendees_image4.png

    Technical Overview

    The following section describes technical information for the Retrieve Attendees product integration.

    Technical Flow Diagram

    The following diagram illustrates the technical workflow:

    technical_workflow_diagarm.png

    Technical Workflow Diagram

    RESTful API Vendor

    Create the API with the following requirements:
    • The API receives an eventRef parameter (path/query parameter) or another user identification method.
    • The API returns a JSON response with the following structure:

      retreive_attendance_json.png

    Attribute Mapping

    The following table describes the attribute mapping:

    Field Description Mandatory (Yes/No) Data Type Default Example
    email The student's email yes String - some.email@gmail.com
    firstName The student's first name yes String - First
    lastName The student's last name yes String - Last

    Configuration

    To configure the Retrieve Attendees product integration, select Add Product Integration from the Product Integrations main menu option.
    Select Retrieve Attendees and the following configuration page appears:

    retreive_attendees_configuration.png

    Configuring Retrieve Attendees
    The following table describes the configuration options available on this page.
    Configuration Option Description Mandatory Data Type Default Example
    Enable Product Integration Select to enable the product integration on the user's campusM app. No Check box Yes  
    Product Integration Description A description of the product integration for internal use Yes Description -  
    Vendor Name API Yes      
    URL to retrieve the information The URL for the Web service Yes      
    Response Content Type The Web service’s response content type No      
    URL Query Parameters The parameters sent as part of the query No     For https://someHostName/serviceName?username={user}, the query parameter is username.    
    URL Path Parameters The parameters sent as part of the path     No     For https://someHostName/serviceName/username, the path parameter is username.    
    General Headers Add (key, value) for additional needed headers No      
    Authentication Type Authentication type against the web service. The options are the following:
    • No Auth
    • Basic - username and password for Base64 basic authentication.
    • API Key - can be added to a Header or to the URL (Query Param) or both.
    • Bearer token
    • OAuth Using User App Authentication – select an OAuth integration profile (from the Integration Profiles configured in App Settings) and choose where the access token should be added, Header or URL.
    • OAUTH Using Client Credentials – select this if you are using a preliminary token call to get the access token.
    No      
    • Was this article helpful?