EXPORT - Get a user's enrollments
Resource URL
URL: user/export/enrollments
Parameters
string username | Username |
string password | Password |
int pageNumber | Page number to retrieve |
int pageSize | Maximum number of elements on each page |
string language | Language, available values are: no, en, pr |
Return value
| enrollmentsInformation | A list containing enrollments data for a specific user |
| enrollmentsInformation[].id | ID of the user |
| enrollmentsInformation[].externaIld | External ID of the user |
| enrollmentsInformation[].enrollments[].courseName | Name of course |
| enrollmentsInformation[].enrollments[].enrollmentReferenceId | Reference for the enrollment. Used for getting course certificate |
| enrollmentsInformation[].enrollments[].courseId | Trainingportal ID for the course |
| enrollmentsInformation[].enrollments[].courseExternalId | External ID for the course |
enrollmentsInformation[].enrollments[].completionDate | yyyy-MM-dd - the date when course was completed. Empty value indicates, that the course is not yet completed |
enrollmentsInformation[].enrollments[].validUntilDate | yyyy-MM-dd - if a course has validity period, than this indicates the time it expires |
enrollmentsInformation[].enrollments[].certificateAvailable | Whether a certificate is available. Possible values are: true / false |
enrollmentsInformation[].enrollments[].enrollmentStatus | Status of the enrollment.
|
| pageNumber | Number of the current page |
| pageSize | Size of the current page |
Example request
URL | https://www.trainingportal.no/mintra/rest/user/export/enrollments |
| POST DATA | username=username&password=secret&language=en&pageNumber=10&pageSize=20 |
{
"enrollmentsInformations": [
{
"id": 123,
"externalId": "abc",
"enrollments": [
{
"courseName":"ABC Test",
"enrollmentReferenceId":"aasd-1234-zcvqwer-qasdfasdf",
"courseId":1234,
"courseExternalId":"aaa001",
"completionDate": "2011-05-10",
"enrollmentStatus": "APPROVED",
"validUntil": null,
"certificateAvailable": true
},
{
"courseName":"CDE Test"
"enrollmentReferenceId":"aaqfqwsd-1234-2werff-vbdfr",
"courseId":1235,
"courseExternalId":"aaa002",
"completionDate": null,
"enrollmentStatus": "APPROVED",
"validUntil": null,
"certificateAvailable": false
}
]
}
],
"pageNumber": 10,
"pageSize": 20
}
