Get enrollments in a period
Resource URL
POST enrollment/enrollments
Parameters
string username | Username |
string password | Password |
string startDate | Start Date for period the result should be limited to. Date format: YYYY-MM-DD. |
| string endDate optional | End Date for period the result should be limited to. Date format: YYYY-MM-DD. |
Return value
The method returns a list of enrollments that have been created in the given period. Each item in the list has the following properties:
userId | Trainingportal ID for the user |
userExternalId | External ID for the user |
| courseId | Trainingportal ID of the course |
courseExternalId | External ID of the course |
enrollmentDate | yyyy-MM-dd – the date when the user was enrolled on the course |
enrollmentReferenceId | Reference for the enrollment |
Example request
POST | https://www.trainingportal.no/mintra/rest/enrollment/enrollments |
POST DATA | username=username&password=secret&startDate=2014-06-01 |
{ "enrollments" : [
{ "courseExternalId" : "course_externalId",
"courseId" : 2,
"enrollmentDate" : "2014-06-06",
"enrollmentReferenceId" : "0647b2c1-abab-4b5f-cdcd-dc7329b33c17",
"userExternalId" : "user_external_id",
"userId" : 1
},
{ "courseExternalId" : null,
"courseId" : 1,
"enrollmentDate" : "2014-06-11",
"enrollmentReferenceId" : "e51ce0f3-cdcd-abab-a6e1-b520a6232e41",
"userExternalId" : null,
"userId" : 2
}]
}
