Get course catalogue
Resource URL
URL: v2/course/catalogue
Parameters
string username | Username |
string password | Password |
string phrase | Phrase to search for. |
string courseProvider | Course provider to narrow down results. |
string courseType | Course type to narrow down results |
string courseCategoryId | Course category id to narrow down results |
boolean onlyActive | Whether only courses activated for current portal should be returned. If set to false, all available courses are returned. |
string sortColumn | Name of the field which should be used for sorting results. Currently only possible value is "name". Other possibilities may be added in future. |
string sortOrder | Possible values are "asc" (for ascending order) and "desc" (for descending order) |
int pageSize | Results page size. Max value is 100. If higher value is set, than it will be trimmed to max value. |
int pageNr | Number of results page. Pages count starts from 1. |
string language | Language, available values are: |
Return value
queryParameters | Values of query parameters that were used to perform query. If empty value was sent for some parameters, default value may be returned | ||
language | |||
courseType | |||
courseProvider | |||
courseCategory | selected course category id (if courseCategoryId parameter was not empty) | ||
id | |||
name | |||
ancestors - a list of supercategories (if there are any) of the selected category. First one is a root-category, last one is the parent of selected category. Each element has:
| |||
pageNr | |||
sortColumn | |||
phrase | |||
sortOrder | |||
pageSize | |||
totalResults | Total number of results matching query | ||
courseTypes | Course types to which resulting courses belong. Available vaues are:
| ||
courseProviders | Course providers of courses matching query. | ||
| id | |||
| name | |||
courseCategories | Course categories of courses matching query. | ||
| id | |||
| name | |||
| resultsCount | |||
coursesInfo | Collection of course details objects | ||
name | |||
id | |||
type | |||
description | |||
Example request
URL | https://www.trainingportal.no/mintra/rest/v2/course/catalogue |
| POST DATA | username=username&password=secret&pageSize=3 |
{
"queryParameters": {
"language": "no",
"courseType": null,
"courseProvider": null,
"courseCategoryId": null,
"pageNr": 1,
"sortColumn": "name",
"onlyActive": true,
"phrase": null,
"sortOrder": "asc",
"pageSize": 3
},
"totalResults": 30,
"courseTypes": [
{
"value": "BLENDED_COURSE"
},
{
"value": "ELEARNING_COURSE"
}
],
"courseProviders": [
{
"name": "Mintra As"
},
{
"name": "Nosefo"
},
{
"name": "Vestteknikk"
}
],
"courseCategories": [
{
"name": "Apos",
"id":11,
"resultsCount":11
},
{
"name": "E-læring",
"id": 1,
"resultsCount" : 21
}
],
"coursesInfo": [
{
"name": "Excel 2007 NO-EN",
"id": 745,
"type": "ELEARNING_COURSE",
"description": "<p>Dette kurset tar for seg både grunnleggende og mer avanserte emner. Du lærer alt fra <br />grunnleggende emner som redigering, formatering, formler og utskrift, til mer avanserte emner som <br />funksjoner, diagram, lagring som websider og bruk av flere regneark.</p>"
},
{
"name": "Flensetrekking - Interaktivt introduksjonskurs",
"id": 677,
"type": "ELEARNING_COURSE",
"description": "<p>Kurset gir grunnleggende forståelse for arbeid på flensende forbindelser.</p>\r\n<p>Kursmodulene danner grunnlag for en beste-praksis-database innen arbeid på hydrokarbonførende rør.</p>"
},
{
"name": "Flensetrekking - interaktivt introduksjonskurs - Engelsk versjon",
"id": 655,
"type": "ELEARNING_COURSE",
"description": "<p>Kurset gir grunnleggende forståelse for arbeid på flensende forbindelser.</p>\r\n<p>Kursmodulene danner grunnlag for en beste-praksis-database innen arbeid på hydrokarbonførende rør.</p>"
}
]
}
