GET restapi/personal/courses/withrole/{courseId}/v1
Retrieves basic information on the given course for the current user and their course role in this course.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| courseId |
Identifier of the course to retrieve |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Object containing the course information and the role of the current user in this course.
Itslearning.RestApi.Entities.CourseWithContextRole| Name | Description | Type | Additional information |
|---|---|---|---|
| ContextRole |
The context role for the current person . |
Itslearning.RestApi.Entities.PersonContextRole |
None. |
| OrganisationLegalId |
External identifier of the organisation the course is connected to. |
string |
None. |
| OrganisationSyncKey |
Sync key of the organisation the course is connected to. |
string |
None. |
| Code | string |
None. |
|
| CourseId | integer |
None. |
|
| CreatedDateTimeUtc | date |
None. |
|
| Title | string |
None. |
|
| OrganisationId | integer |
None. |
|
| CourseColorClass | string |
None. |
|
| SyncKey | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ContextRole": 1,
"OrganisationLegalId": "sample string 1",
"OrganisationSyncKey": "sample string 2",
"Code": "sample string 3",
"CourseId": 4,
"CreatedDateTimeUtc": "2025-06-18T13:54:23Z",
"Title": "sample string 5",
"OrganisationId": 6,
"CourseColorClass": "sample string 7",
"SyncKey": "sample string 8"
}