Add course class
Adds a course class to a course
Resource URL
URL: v1/courses/get/{externalCourseId}/courseClasses/add
Request Method
POST | GET |
Parameters
string username | Username |
string password | Password |
string externalCourseId path variable | Course provider's ID for the course |
string externalId | The course provider's ID for the course class (in their booking system) |
string location required | Location for the course class |
int availableSeats | Number of available seats. Must be a positive number or zero. |
Date enrollmentDeadline required | Enrollment deadline |
Date cancellationDeadline required | Cancellation deadline |
Date startDate required | Start date |
Time startTime | Start time |
Date endDate required | End date |
Time endTime | End time |
AddressDto address Address required fields:
| |
PriceDto price Price consists of:
| Allowed currencies: NOK, EUR, USD, GBP |
boolean sendScheduleInfoToParticipants | If true the system will send calendar invitation information to the students on the class. |
Return value
Returns information on the created course class
cancelled | false | ||
courseExternalId | The course provider's ID for the course (in their booking system) | ||
externalId | The course provider's ID for the course class (in their booking system) | ||
location | Location for the course class | ||
availableSeats | Number of available seats | ||
enrollmentDeadline | Enrollment deadline | ||
cancellationDeadline | Cancellation deadline | ||
startDate | Start date | ||
startTime | Start time | ||
endDate | End date | ||
endTime | End time | ||
address Address consists of:
| |||
price Price consists of:
| |||
boolean sendScheduleInfoToParticipants | If system should send calendar invitation information to the students on the class. |
Example request
URL | https://www.trainingportal.no/mintra/api/courseprovider/rest/v1/courses/get/6/courseClasses/add |
POST DATA | username=username&password=secret&.... |
{ "cancelled" : false , "courseExternalId" : "6" , "externalId" : "1234" , "location" : "Oslo" , "availableSeats" :10, "enrollmentDeadline" : "2015-06-12" , "cancelationDeadline" : "2015-06-13" , "startDate" : "2015-06-20" , "startTime" : "00:00:00" , "endDate" : "2015-06-25" , "endTime" : "00:00:00" , "address" : { "addressLine1" : "Storgata 1" , "addressLine2" : "" , "city" : "Oslo" , "zipCode" : "12" , "country" : "Norway" }, "price" : { "amount" :5600.00, "currency" : "NOK" }, "sendScheduleInfoToParticipants" : true }
|