Utility.GetCourseLoginURL Method

UtilityGetCourseLoginURL Method

A Sandcastle Documented Class Library

This method returns an encrypted url that can be used to send the student to a page where they can select a course to view.

Namespace: WCFAPI
Assembly: WCFAPI (in WCFAPI.dll) Version: 4.0.0.0 (4.0.0.0)

Syntax

C++

Copy

public string GetCourseLoginURL(
	string apiUsername,
	string apiPassword,
	string StudentExternalID
)

Public Function GetCourseLoginURL ( 
	apiUsername As String,
	apiPassword As String,
	StudentExternalID As String
) As String

public:
virtual String^ GetCourseLoginURL(
	String^ apiUsername, 
	String^ apiPassword, 
	String^ StudentExternalID
) sealed

abstract GetCourseLoginURL : 
        apiUsername : string * 
        apiPassword : string * 
        StudentExternalID : string -> string 
override GetCourseLoginURL : 
        apiUsername : string * 
        apiPassword : string * 
        StudentExternalID : string -> string

Parameters

apiUsername: Type: SystemString
Username of the API user
apiPassword: Type: SystemString
Password of the APU user
StudentExternalID: Type: SystemString
Unique ID used to identify the student in your system

Return Value

Type: String
URL that will log the user in or the message "Student does not exist" if the student cannot be found

Reference

Utility Class

WCFAPI Namespace