GET api/assessmentSessions/getDiagnosticAssessmentSessionLinkForCourse?courseSubject={courseSubject}&userId={userId}
Get diagnostic assessment session link for a course and user. Please note: This will return assessment session for current working level on the course. It will throw a generic exception (please see API Generic Exception section) in case where working level is not set (i.e., initial assessment is not taken or working level is not set by a tutor.)
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| courseSubject | string |
Required |
|
| userId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
AssessmentSessionLink| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
User Id. |
integer |
None. |
| AssessmentId |
Assessment Id. |
integer |
None. |
| AssessmentName |
Assessment name. |
string |
None. |
| Session |
Assessment session. |
AssessmentSession |
None. |
| Expiry |
Link token expiry date. |
date |
None. |
| Token |
Login token for assessment session |
string |
None. |
| Link |
Assessment session link (includes auto-login). |
string |
None. |
| ReturlUrl |
Return Url |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"UserId": 1,
"AssessmentId": 2,
"AssessmentName": "sample string 3",
"Session": {
"SessionId": 1,
"UserId": 2,
"DateStarted": "2025-02-23T04:55:49.3623652+00:00",
"SessionStatus": 1,
"SessionType": 1
},
"Expiry": "2025-02-23T04:55:49.3623652+00:00",
"Token": "sample string 5",
"Link": "sample string 6",
"ReturlUrl": "sample string 7"
}
application/xml, text/xml
Sample:
<AssessmentSessionLink xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<UserId>1</UserId>
<AssessmentId>2</AssessmentId>
<AssessmentName>sample string 3</AssessmentName>
<Session>
<SessionId>1</SessionId>
<UserId>2</UserId>
<DateStarted>2025-02-23T04:55:49.3623652+00:00</DateStarted>
<SessionStatus>Complete</SessionStatus>
<SessionType>InitialAssessment</SessionType>
</Session>
<Expiry>2025-02-23T04:55:49.3623652+00:00</Expiry>
<Token>sample string 5</Token>
<Link>sample string 6</Link>
<ReturlUrl>sample string 7</ReturlUrl>
</AssessmentSessionLink>
