EXPORT - Get a user's course bookings
Resource URL
URL: user/export/coursebookings
Parameters
string username | Username |
string password | Password |
int pageNumber | Page number to retrieve |
int pageSize | Maximum number of elements on each page |
string language | Language, available values are: no, en, pr |
Return value
Method returns collection of enrollments. Each element contains following fields:
| courseBookings | A list containing course booking data for a specific user |
| courseBookings[].id | ID of the user |
| courseBookings[].externalId | External ID of the user |
courseBookings[].bookings[].enrollmentReferenceId | Unique identifier of an enrollment. |
| courseBookings[].bookings[].courseName | Course name |
| courseBookings[].bookings[].courseClassName | Course class name |
| courseBookings[].bookings[].courseId | Unique identifier of course |
| courseBookings[].bookings[].courseClassId | Unique identifier of course class |
| courseBookings[].bookings[].location | Name of the location |
| courseBookings[].bookings[].address | Contains location where course class is going to take place. Can be empty when course class has multiple sessions in different locations. Consists of:
|
| courseBookings[].bookings[].startDate | Course class start date. Format: yyyy-MM-dd |
| courseBookings[].bookings[].startTime | Course class start time. Format hh:mm |
| courseBookings[].bookings[].endDate | Course class end date. Format: yyyy-MM-dd |
| courseBookings[].bookings[].endTime | Course class end time. Format hh:mm |
| pageNumber | Number of the current page |
| pageSize | Size of the current page |
Example request
URL | https://www.trainingportal.no/mintra/rest/user/export/coursebookings |
| POST DATA | username=username&password=secret&pageNumber=10&pageSize=20 |
{
"coursebookings": [
{
"id": 123,
"externalId": "abc",
"bookings": [
{
"address": {
"location": "Kobbervikdalen 61",
"city": "Drammen",
"zipCode": "3036",
"contry": ""
},
"startTime": "09:00",
"endTime": "16:00",
"courseId": 6547,
"courseClassId": 12345,
"startDate": "2014-05-05",
"courseClassName": "Kis kompetanse AS",
"courseName": "Anleggasmaskin - Modul 1.1, 2.1 og 3.1",
"endDate": "2014-05-09",
"enrollmentReferenceId": "fwere92f-b3e1-412a-a452-fe6e2b51afa9",
"courseExternalId": "",
"location": "Bergen"
}
]
}
]
}
