Get cancelled enrollments in period
Resource URL
POST enrollment/cancelledEnrollments
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 cancelled in the give 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 |
cancellationDate | yyyy-MM-dd – the date when the enrollment was cancelled |
Example request
POST | https://www.trainingportal.no/mintra/rest/enrollment/cancelledEnrollments |
POST DATA | username=username&password=secret&startDate=2014-06-01 |
{
"enrollments": [
{
"cancellationDate": "2014-07-09",
"courseExternalId": null,
"courseId": 1,
"userExternalId": null,
"userId": 1
},
{
"cancellationDate": "2014-07-09",
"courseExternalId": "courseExternalId",
"courseId": 2,
"userExternalId": "userExternalId",
"userId": 2
}
]
}
