Get course participants
Resource URL
POST course/courseParticipants
Parameters
string username | Username |
string password | Password |
string courseId | Unique course identifier. |
string courseExternalId | Unique external course identifier. Either courseId or courseExternalId must be filled |
Return value
The method returns a list of users enrolled on the course. Each item in the list has the following properties:
enrollmentReferenceId | Reference for the enrolment. Used for getting course certificate |
userId | Trainingportal ID for the user |
userExternalId | External ID for the user |
enrollmentDate | yyyy-MM-dd – the date when the user was enrolled on the course |
enrollerUserId | Trainingportal ID for the administrator/user who enrolled the user |
completionDate | yyyy-MM-dd – the date when course was completed. Empty value indicates, that the course is not yet completed |
validUntilDate | yyyy-MM-dd – If a course has a validity period, then this indicates the time it expires |
certificateAvailable | Whether a certificate is available. Possible values are: true / false |
enrollmentStatus | Status of the enrolment.
|
courseStatus | Status of the course:
For courses without e-learning , only NOT_ATTEMPTED and COMPLETED are used |
Example request
POST | https://www.trainingportal.no/mintra/rest/rest/course/courseParticipants |
POST DATA | username=username&password=secret&courseId=5043 |
{ "participants": [
{ "enrollmentReferenceId" : "asd-3214-asfdasf-asdasdv",
"userId" : 9954,
"userExternalId" : "xx12" ,
"enrollmentDate" : "2012-09-01" ,
"enrollerUserId" : 1024 ,
"completionDate" : "2012-10-15" ,
"validUntilDate" : "2014-10-15" ,
"certificateAvailable" : true ,
"enrollmentStatus" : "APPROVED" ,
"courseStatus" : "COMPLETED"
},
{
"enrollmentReferenceId" : "asd-5462-asfdasf-asdasdv",
"userId" : 9953,
"userExternalId" : "xx13" ,
"enrollmentDate" : "2012-09-01" ,
"enrollerUserId" : 1024 ,
"completionDate": null ,
"validUntilDate" : null ,
"certificateAvailable" : false ,
"enrollmentStatus" : "APPROVED" ,
"courseStatus" : "NOT ATTEMPTED"
}
]}
