Skip to content

blackboard/BBDN-CSharp-WS-Sample

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 

Repository files navigation

BBDN-CSharp-WS-Sample

NOTE: SOAP Web Services have been removed from the Blackboard Learn product as of the Q4 2019 Release (3900.0.0)

This project contains sample code for interacting with the Blackboard Learn SOAP Web Services in C#. This sample uses the library built from the Sample code available with for download directly from Blackboard Learn. The code demonstrates the code necessary to register a Proxy Tool, login as a tool or user, and retrieve a list of courses a specified user is enrolled in and the role that user has in those courses.

###Project at a glance:

  • Target: Blackboard Learn 9.1 SP 11 minimum
  • Source Release: v1.0
  • Release Date 2015-02-25
  • Author: shurrey
  • Tested on Blackboard Learn 9.1 April 2014 release

###Requirements:

  • Visual Studio - This sample was built with Microsoft Visual Studio 2010 Express Edition
  • Requires the BbWsClient.dll. See Blackboard Help for more information.

Setting Up Your Project

Open Microsoft Visual Studio. Click File->Open and navigate to the directory you cloned this project in. Select BbCSharpSample.sln and open it. Your project workspace is now ready to go.

You may need to add a few references. To accomplish this, you will need to right click on 'References' in the Solution Explorer and then select 'Add Reference...'. From the browse tab, navigate to the BbWsClient.dll file you built from the .NET sample code downloaded from the Blackboard Learn interface. Repeat the process to access the 'Add Reference..' section, and in the .NET tab, you may need to add System.Web, System.Web.Services, and System.Security.

Using the Code Sample

This code sample starts as a web form that gathers information. This web form allows you to:

  • Register a proxy tool
  • login as a proxy tool
  • login as any Blackboard user
  • retrieve a list of courses a specified user is enrolled in and their role in that course.

The web form asks for a URL. This URL must contain the protocol at the beginning: https://localhost:9877

If registering a tool, you must approve the tool on the Blackboard Learn side before you can login as a tool or a user.

If logging in as a user, the user must have administrator rights in order to successfully query the Web Services and retrieve the desired data.

Developer Virtual Machine and SSL Certificate Checking

If you decide to use the Blackboard Developer virtual machine, it is important to note that this VM contains a self-signed certificate, which will cause this code to fail. Because the Blackboard Learn 9.1 April and newer releases require you to use SSL, there is a constant in program.cs called IGNORE_CERT_ERRORS. Setting this constant to true WILL BYPASS SSL CERTIFICATE CHECKING, so be sure to undo this change when rolling out to production.

Conclusion

This code will give you the base knowledge you need to interact with the Blackboard Learn SOAP services using the .NET sample code library provided with Learn. A full walkthrough of this code will be documented at https://help.blackboard.com. Once this is complete, a link to that document will be added here.

About

This project contains sample code for interacting with the Blackboard Learn SOAP Web Services in C#.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages