EXPORT - Get all competence statuses for a user
Resource URL
URL: user/export/competenceStatus
Parameters
string username | Username |
string password | Password |
int pageNumber | Page number to retrieve |
int pageSize | Maximum number of elements on each page |
string competenceType | Limit the result to competencies of this type. Possible values:
Default value: no filter |
| boolean showActiveRequirementsOnly optional | If true, the method will only return the statuses for the user's active requirements.Default value: false |
| string language optional | Language, available values are: no, en, pr Default value: no |
Return value
| userCompetences | A list containing activation status data for a specific user |
| userCompetences[].id | ID of the user |
| userCompetences[].externalId | External ID of the user |
| userCompetences[].competences[] | A list of competences |
userCompetences[].competences[].completionDate | yyyy-MM-dd - the date when competence was completed. Empty value indicates, that the competence is not yet completed |
userCompetences[].competences[].validUntilDate | yyyy-MM-dd - if a competence has validity period this indicates the time it expires |
userCompetences[].competences[].status | Status of the competence.
|
| userCompetences[].competences[].requirementReferenceId | Identifier of the requirement (if requirement exists) |
| userCompetences[].competences[].competenceId | Id of the competence |
| userCompetences[].competences[].competenceExternalId | External Id of the competence. Null if no external Id is defined |
| userCompetences[].competences[].competenceName | Name of the competence |
| pageNumber | Number of the current page |
| pageSize | Size of the current page |
Example request
URL | https://www.trainingportal.no/mintra/rest/user/competenceStatus |
| POST DATA | username=username&password=secret&language=en&pageNumber=10&pageSize=20 |
{
"userCompetences": [
{
"id": 123,
"externalId": "abc",
"competences": [
{
"status":"COMPLETED",
"requirementReferenceId":"41654228-9bd3-435f-9682-feee",
"competenceId":23518,
"competenceExternalId":null,
"competenceName":"Heart starter",
"completionDate":"2015-04-02",
"validUntilDate":null
},
{
"status":"COMPLETED",
"requirementReferenceId":"eea234-3e58-4dd2-a634-0c54fd5c7dd2",
"competenceId":136,
"competenceExternalId":null,
"competenceName":"Theory & Exam: Portable Radio",
"completionDate":"2014-10-12",
"validUntilDate":"2016-10-12"
}
]
}
],
"pageNumber": 10,
"pageSize": 20
}
