Quality management APIs

POST quality/documents/{qualityDocumentId}/versions/{qualityDocumentVersionId}/quiz-answers

Sends answers given by user to calculate score

HTTP method	POST
URI	https://api.rambase.net/quality/documents/{qualityDocumentId}/versions/{qualityDocumentVersionId}/quiz-answers
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {qualityDocumentId}	Identifier of the quality document Integer, minimum 1
- URI parameter {qualityDocumentVersionId}	Quality Document Version identifier Integer, minimum 1
Successful HTTP status code	200
API resource identifier	6305, version 7

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:

                                        <Parameters>
                                    

                                             <QuizAnswers>
                                    

                                                  <QuizAnswer>
                                    

<QuestionKey

QuestionKey

Required/mandatory field

A question identifier

>{String}</QuestionKey>

<AnswerKey

AnswerKey

Required/mandatory field

An answer identifier

>{String}</AnswerKey>

                                                  </QuizAnswer>
                                    

                                             </QuizAnswers>
                                    

                                        </Parameters>
                                    

{

                                             "parameters": {
                                    

                                                  "quizAnswers": [
                                    

{

"questionKey

QuestionKey

Required/mandatory field

A question identifier

": "{String}",

"answerKey

AnswerKey

Required/mandatory field

An answer identifier

": "{String}"

}

]

}

}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional	After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional	Set the database/company for the request
$useMinimumVersion Integer, optional	Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$lang String, optional	Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:

                                        <QuizResult>
                                    

<ScorePercent

ScorePercent

Field that refers to the score a user receives

>{Decimal}</ScorePercent>

<Passed

Passed

Field that informs whether the user has passed the quiz or not

>{Boolean}</Passed>

<IsResultSaved

IsResultSaved

Field that informs whether a result is saved or not

>{Boolean}</IsResultSaved>

                                             <QuizAnswers>
                                    

                                                  <QuizAnswer>
                                    

<QuestionKey

QuestionKey

A question identifier

>{String}</QuestionKey>

<IsCorrect

IsCorrect

Field informing whether the question was answered correctly or not

>{Boolean}</IsCorrect>

                                                  </QuizAnswer>
                                    

                                             </QuizAnswers>
                                    

                                        </QuizResult>
                                    

{

                                             "quizResult": {
                                    

"scorePercent

ScorePercent

Field that refers to the score a user receives

": "{Decimal}",

"passed

Passed

Field that informs whether the user has passed the quiz or not

": "{Boolean}",

"isResultSaved

IsResultSaved

Field that informs whether a result is saved or not

": "{Boolean}",

                                                  "quizAnswers": [
                                    

{

"questionKey

QuestionKey

A question identifier

": "{String}",

"isCorrect

IsCorrect

Field informing whether the question was answered correctly or not

": "{Boolean}"

}

]

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return: