Get course completions in a period
Resource URL
URL: courseCompletion/completions
Parameters
string username | Username |
string password | Password |
| string startDate required | 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. If end date is not set, today's date will be used |
boolean useCompletionDate optional | Default false. false means startDate and endDate will be used to find course completions which were registered/changed/updated/created between startDate and endDate (course completion date is not used in this case). This version is useful to get all the newest information about all changes made in completions (possibly for integration with changes tracking). true means startDate and endDate will be used to find course completion with completion date in period between startDate and endDate. This version is useful for getting information about all completed courses in a period of time. |
| string userId optional | Find completions only for a specific userId |
| string courseId optional | Find completions only for a specific courseId |
Return value
Returns a list of course completions, each with the following values:
| userId | Trainingportal ID of the user |
| userExternalId | External ID of the user |
| courseId | Trainingportal ID of the course |
| courseExternalId | External ID of the course |
completionDate | yyyy-MM-dd - the date when course was completed. |
validUntilDate | yyyy-MM-dd - if a course has validity period, than this indicates the time it expires |
certificateAvailable | Whether a certificate is available. Possible values are: true / false |
enrollmentReferenceId | Reference for the enrollment, used for retrieving course certificates |
Example request
URL | https://www.trainingportal.no/mintra/rest/courseCompletion/completions |
| POST DATA | startDate=2011-05-10&endDate=2011-05-12&username=username&password=secret |
{ "courseCompletions": [
{
"userId": 123456,
"userExternalId": null,
"courseId": 123,
"courseExternalId": "a001",
"completionDate": "2011-05-10",
"validUntilDate:" null,
"enrollmentReferenceId": "d1dff733-51d1-4853-bc11-96939c16ebc4",
"certificateAvailable": true
},
{
"userId": 123456,
"userExternalId": null,
"courseId": 124,
"courseExternalId": "a002",
"completionDate": "2011-05-11",
"validUntilDate:" null,
"enrollmentReferenceId": "d1dffe33-5ed1-4e853-be11-96939c16ebc4",
"certificateAvailable": true
}
]
}
