List competences
Resource URL
URL: competence/listCompetences
Parameters
string username | Username |
string password | Password |
string locale | Choose the language for names Default value: "en" |
| int catalogueId required | The id of the catalog to list competences from. |
| string competenceType optional | Limit search to this competence type. |
| int pageSize optional | Results page size. Max value is 100. If higher value is set, than it will be trimmed to max value. Default value: 20 |
| int pageNr optional | Number of results page. Pages count starts from 1. Default value: 1 |
Return value
totalSize | Total number of results matching query | ||||||||||||||||||||||||
pageSize | The number of results on each page | ||||||||||||||||||||||||
pageNr | The page number of the current page | ||||||||||||||||||||||||
locale | Selected locale (language) | ||||||||||||||||||||||||
competenceType | Selected competence type to filter on, or null if no filter. | ||||||||||||||||||||||||
catalogueName | The name of the current catalogue. | ||||||||||||||||||||||||
catalogueId | The id of the current catalogue. | ||||||||||||||||||||||||
| competenceList | Lists of the competences found
|
Example request
URL | https://www.trainingportal.no/mintra/rest/competence/listCompetences |
| POST DATA | username=username&password=secret&pageSize=3&catalogueId=14 |
{
"totalSize": "1234",
"pageSize": 3,
"pageNr": 1,
"locale": "en",
"competenceType": null,
"catalogueName": "Test portal",
"catalogueId": 14,
"competenceList": [
{ "name":"Function Manager",
"id":36250,
"externalId":"adf7543",
"type":"ROLE",
"active":true,
"organizationUnit":null,
"categories":
[
{ "name":"Base",
"id":1506}
]
},
{ "name":"Method Engineer- Piping ",
"id":36251,
"externalId":"adf7465",
"type":"ROLE",
"active":true,
"organizationUnit":
{
"name":"Test organization unit",
"id":12321,
"externalId":"hgf1234"
},
"categories":
[
{
"name":"Piping",
"id":1512
}
]
},
{
"name":"Functional Manager",
"id":36252,
"externalId":"adf46374",
"type":"ROLE",
"active":true,
"organizationUnit":null,
"categories":null
}
]
}
