The Roster Exchange API Integration allows Barnes & Noble College to gather course enrollment information to use for billing purposes when content is provisioned in a First Day program.

Set Up the API Roster Exchange 

Part 1: Create a Role with Permissions 

  1. Click on the gear icon to view the Admin Tools.
  2. Under the Security Tab, select Roles & Permissions.
  3. Click Create/Copy.
  4. You can copy an existing role if you like or start fresh. Either way, make sure your role is configured as noted in the next steps.
    • General
      • Name: Barnes and Noble College
      • Cascading Role: Check this box
      • Description: Can add if needed
      • Role Alias: Can add if needed
    • You do not need to select anything in Tool Behavior Options or Classlist Display Options.
    • Course Access Options:
      • Access Inactive Courses: Check the box
      • Access Past Courses: Check this box
      • Access Future Courses: Check this box
      • Access All Course Sections
      • Access All Course Groups
  5. Click Save.
  6. On the Edit Role Interactions page, check all boxes for your Administrator role.
  7. Click Save and you have created the role.
  8. On the Role List page, click the down arrow next to the BNC role you just created and select Edit Permissions.
  9. In the Filter by Tool dropdown menu, select Classlist and click Apply Filter. Check the following boxes and click Save:
    • Has Access to the Classlist: All Boxes
    • See Classlist Report: All boxes
    • View Group Enrollments: All boxes
  10. In the Filter by Tool dropdown menu, select Course Management Console and click Apply Filter. Check the following boxes and click Save.
    • See Course Info: Course Offering, Group, Semester, Section, Department, Program, School Type, Campus
    • See Tool Management: Course Offering
    • Set Tool Status: Course Offering
  11. In the Filter by Tool dropdown menu, select External Learning Tools and click Apply Filter. Check the following boxes and click Save.
    • Manage External Learning Tools Configuration: Course Template, Course Offering, Semester, Section, Department, Program
    • Launch External Learning Tool Links: Course Offering
    • Manage External Learning Tool Links: Course Template, Course Offering, Semester, Section, Department, Program
    • Manage External Learning Tool Providers: Course Template, Course Offering, Semester, Section, Department, Program
    • Create External Learning Tool Links from available External Learning Tool Providers: All boxes
  12. In the Filter by Tool dropdown menu, select My Org Units and click Apply Filter. Check the following boxes and click Save.
    • See My Org Units: Organization, Course Template, Course Offering, Group, Semester, Section, Department, Program
    • Manage My Org Units tool: Course Offering
  13. In the Filter by Tool dropdown menu, select Org Unit Editor and click Apply Filter. Check the following boxes and click Save.
    • Can Create and Edit Org Units: Organization
  14. In the Filter by Tool dropdown menu, select Tool Management and click Apply Filter. Check the following boxes and click Save.
    • See Org Tool Management: Organization
  15. In the Filter by Tool dropdown menu, select User Information Privacy and click Apply Filter. Check the following boxes and click Save.
    • See First Names: All boxes
    • See Last Names: All boxes
    • See Usernames: All boxes
    • See Org Defined IDs: All boxes
    • See Email Addresses: All boxes
  16. In the Filter by Tool dropdown menu, select Users and click Apply Filter. Check the following boxes and click Save.
    • View the Users’ Email Address: Organization, Course Template, Course Offering, Group, Semester, Department, Program
    • View Users’ Org Defined IDs: Organization, Course Template, Course Offering, Group, Semester, Department, Program
    • View User Enrollments: Organization, Course Template, Course Offering, Group, Semester, Department, Program
    • Search for ‘Instructor’: All boxes
    • Search for ‘Student’: All boxes

Part 2: Create a System User

  1. Navigate to the Settings Menu (gear icon) and select Users.
  2. Click New User and enter the following:
    • First Name: Barnes & Noble College
    • Last Name: Integration
    • Username: bnc.integration
    • Role: Select the Barnes and Noble College role you created in Part 1
    • Password: Check the Manually set password box and enter a password that you will remember. You will need this later.
  3. Click Save.

Part 3: Register an App 

  1. Navigate to the Settings Menu (gear icon) and select Manage Extensibility.
  2. Click Register an App and enter the following:
    • Application Name: Barnes & Noble College
    • Trusted URL: https://lti.bncollege.com/oauth2callback
    • Major and minor version box is mandatory for the admin to fill in as well.
    • Enable this application: Check this box
    • I accept the Non-Commercial Developer Agreement: Check this box
    • Click Register Application
  3. Copy the Application ID and Application Key and save them. You’ll need them again.
  4. Click Register Application.
  5. Copy the Application ID & Application Key and send them to the BNC team along with the URL for your Brightspace site.

Part 4: Authenticate

  1. The BNC team will send you an authentication link after receiving the application key and ID from you.
  2. Before clicking the link, go to your Brightspace site and make sure you are logged out of your own account.
  3. Click the link and enter the username and password for the user you created in Part 2 above.
  4. You should receive a Success! message meaning that you have authenticated the rostering application. Send a confirmation back to the BNC team.
  5. Once they have confirmed that the setup was successful, please click on the Course Material link in a course (real or test course) in your upcoming term.
    • If there are no courses with the Course Material link currently installed for the upcoming term, please add to a course and click.
      • This will initiate the API sync and allow us to begin pulling course and roster information.

For Next Term

The D2L API allows us to pull course and roster information for courses associated to terms that have been initiated by a sync. This term sync is initiated with a click on the BNC Course Material link within a course associated to the upcoming term. In order to pull course and roster information for each new term, please be sure to click on the Course Material link in a course in the upcoming term (step 5 above under "Authenticate") to initiate the new term sync.

 

Note

Let the BNC team know if any staff or test user accounts are commonly enrolled in Brightspace courses (specifically, under the student role), and we will make note to omit them from course roster counts.

Remove the Roster Exchange API Configuration

Stop

DO NOT remove this API until your current term courses have fully completed, or students will lose access to their materials.

You must only complete this step if you had a First Day program prior to the upcoming term. Otherwise, go back to the first step, Set Up the API Roster Exchange.

  1. Click on the gear icon again to view the Admin Tools.
  2. Under the Organization Related section, click on the Manage Extensibility link.
  3. Locate and click on the Roster API v1.0 API.
  4. Click Delete.
  5. In the confirmation window, click Delete again.
Was this article helpful?
0 out of 0 found this helpful