Get competence completions in a period
Resource URL
URL: competenceCompletion/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 excludeCompetenceGroupsAndRoles optional | If you don't want to include completions on competence groups and roles, set this to TRUE. Default value: FALSE. |
Return value
Returns a list of competence completions, each with the following values:
userId | Trainingportal ID of the user |
userExternalId | External ID of the user |
competenceId | Trainingportal ID of the competence |
competenceExternalId | External ID of the competence |
completionDate | yyyy-MM-dd - the date when competence was completed. |
validUntilDate | yyyy-MM-dd - if a competence has validity period, than this indicates the time it expires |
attachmentsAvailable | Whether a the completion has any attachments. Possible values are: true / false |
requirementReferenceId | Reference for the competence requirement, if present. |
Example request
URL | https://www.trainingportal.no/mintra/rest/competenceCompletion/completions |
POST DATA | startDate=2011-05-10&endDate=2011-05-12&username=username&password=secret |
{ "competenceCompletions": [
{
"userId": 123456,
"userExternalId": null,
"competenceId": 123,
"competenceExternalId": "a001",
"completionDate": "2011-05-10",
"validUntilDate:" null,
"requirementReferenceId": "d1dff733-51d1-4853-bc11-96939c16ebc4",
"attachmentsAvailable": true
},
{
"userId": 123456,
"userExternalId": null,
"competenceId": 124,
"competenceExternalId": "a002",
"completionDate": "2011-05-11",
"validUntilDate:" null,
"requirementReferenceId": "d1dffe33-5ed1-4e853-be11-96939c16ebc4",
"attachmentsAvailable": true
}
]
}