Provide the Base URL

The base URL should include the parameters that are expected by the REST request. The options for the parameters to send on the URL are: (username, password, eventRef and lecturerId)

For example:

http://localhost:8080/extensions/getAttendees?user={username}&pass={password}&eventRef={eventRef}&lecturer={lecturerId}

Or –

http://localhost:8080/extensions/getAttendees/{eventRef}

These placeholders will be replaced with actual data so be sure to use these placeholders exactly: ({username}, {password}, {eventRef}, {lecturerId})

The username, password and eventRef when chosen will be taken from the service request, and the lecturereId will be retrieved by the info given in the LecturerID section (see below).

Authentication Options:

1. No authentication

2. Base64 username and password (system-level username/password which can get info on behalf of each user)

3. Bearer token (system-level token which can get info on behalf of each user)

Indicate which method (GET or POST) and parameter values to use to retrieve user identifier (typically username, email address or student ID)

• Both GET and POST methods are supported
  • For both GET and POST, send the parameters in the URL e.g. http://localhost:8080/extensions/getAttendees?user={username}&pass={password}&eventRef={eventRef}&lecturer={lecturerId}

Ensure response is returned as an array in JSON format

Should include the fields:

• StudentID
• Email
• First Name
• Last Name

Note: The fields 'First Name' and 'Last Name' are optional

Examples:

{

    "attendees": [

        {

            "emailAddress": "test1@gmail.com",

            "studentId": "1234",

            "givenName": "",

            "sureName": "program1"

        },

        {

            "emailAddress": "test2@gmail.com",

            "studentId": "5678",

            "givenName": "test2",

            "sureName": "program2"

        }

    ]

}

Or –

    [

        {

            "emailAddress": "test1@gmail.com",

            "studentId": "1234",

            "givenName": "",

            "sureName": "program1"

        },

        {

            "emailAddress": "test2@gmail.com",

            "studentId": "5678",

            "givenName": "test2",

            "sureName": "program2"

        }

    ]

Provide an email suffix (constant) - Optional

If there is a need to concatenate an email suffix to some field from the JSON response

Provide lecturerID to send on the URL - Optional

Few options:

• Use the username as the lecturerID
• Use a lecturerID from an ldap attribute
• For SSO based authentication – use lecturerID from a SAML/ OAuth attribute (from the token)

Note: If the lecturerID is chosen it will replace {lecturerID} in the URL, but only if this placeholder exists in the URL

Ensure that the APIs and web services are available for calls from the Connect Layer server(s)

Provide a minimum of three (3) test accounts containing comprehensive and typical data, including the following:

• Valid log in credentials for campusM
• Different students list for each test user

Provide Database Connection Details:

• Hostname
• Port
• Database name
• Username
• Password

Ensure the Connect Layer server(s) can connect to the database 

Required to allow Ex Libris to develop and test the created web services

The database view should include the following columns:

• StudentID
• Email
• First Name
• Last Name

Note: The fields 'First Name' and 'Last Name' are optional

The query should return values mapped to these column names (email, studentid, firstname, lastname), and should include the ‘eventRef’ as an input parameter (i.e. “where eventref = ?”) and could optionally include the lecturerID as an input parameter (i.e. “where/AND lecturerid = ?”)

Provide lecturerID to send on the query - Optional

Few options:

• Use the username as the lecturerID
• Use a lecturerID from an ldap attribute
• For SSO based authentication – use lecturerID from a SAML/ OAuth attribute (from the token)

Note: In the query, the eventRef has to come first, and then the lecturerID (i.e. “where eventref =?” OR “where eventref =? and lecturerId = ?”)

Provide a minimum of three (3) test accounts containing comprehensive and typical data, including the following:

• Valid log in credentials for campusM
• Different roles for each test user

Sample Request

Sample Response

{

    "attendees": [

        {

            "emailAddress": "test1@gmail.com",

            "studentId": "1234",

            "givenName": "",

            "sureName": "program1"

        },

        {

            "emailAddress": "test2@gmail.com",

            "studentId": "5678",

            "givenName": "test2",

            "sureName": "program2"

        }

    ]

}