POST api/DriiveAcademy/DriverCourse?driverCourseId={driverCourseId}
Submit responses for a driver course.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
driverCourseId |
The id of the driver course |
integer |
Required |
Body Parameters
DriverCourseResponsesRequest
DriverCourseResponsesRequestName | Description | Type | Additional information |
---|---|---|---|
QuestionResponses |
A list of question responses |
Collection of QuestionResponse |
None. |
Request Formats
application/json, text/json
Sample:
{ "QuestionResponses": [ { "QuestionId": 1, "Response": {}, "Order": 3 }, { "QuestionId": 1, "Response": {}, "Order": 3 } ] }
application/xml, text/xml
Sample:
<DriverCourseResponsesRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <QuestionResponses> <QuestionResponse> <QuestionId>1</QuestionId> <Response /> <Order>3</Order> </QuestionResponse> <QuestionResponse> <QuestionId>1</QuestionId> <Response /> <Order>3</Order> </QuestionResponse> </QuestionResponses> </DriverCourseResponsesRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The score for the course
DriverCourseResponsesResponseName | Description | Type | Additional information |
---|---|---|---|
Score |
The score awarded for the course |
integer |
None. |
Percentage |
The percentage |
decimal number |
None. |
Status |
The status of the course after completion |
DriiveAcademyCourseStatus |
None. |
CertificateURL |
The cretificate URL if the course was passed |
string |
None. |
Attempts |
The number of attempt at a course |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "Score": 1, "Percentage": 2.1, "Status": 0, "CertificateURL": "sample string 3", "Attempts": 4 }
application/xml, text/xml
Sample:
<DriverCourseResponsesResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Score>1</Score> <Percentage>2.1</Percentage> <Status>Scheduled</Status> <CertificateURL>sample string 3</CertificateURL> <Attempts>4</Attempts> </DriverCourseResponsesResponse>