- Description:
- Interface to quiz related API calls
- Source:
Interface to quiz related API calls
Methods
(inner) getQuizNextQuestion(quizId, parametersopt, networkParametersopt) → {Promise}
- Description:
- Retrieve next question from Constructor.io API
- Source:
- See:
-
Example
constructorio.quizzes.getQuizNextQuestion('quizId', {
answers: [[1,2],[1]],
section: '123',
quizVersionId: '123',
quizSessionId: '1234',
});
Parameters:
| Name |
Type |
Attributes |
Description |
quizId |
string
|
|
The identifier of the quiz |
parameters |
string
|
<optional>
|
Additional parameters to refine result set
Properties
| Name |
Type |
Attributes |
Description |
section |
string
|
<optional>
|
Product catalog section |
answers |
array
|
<optional>
|
An array of answers in the format [[1,2],[1]] |
quizVersionId |
string
|
<optional>
|
Version identifier for the quiz. Version ID will be returned with the first request and it should be passed with subsequent requests. More information can be found: https://docs.constructor.io/rest_api/quiz/using_quizzes/#quiz-versioning |
quizSessionId |
string
|
<optional>
|
Session identifier for the quiz. Session ID will be returned with the first request and it should be passed with subsequent requests. More information can be found: https://docs.constructor.io/rest_api/quiz/using_quizzes/#quiz-sessions |
|
networkParameters |
object
|
<optional>
|
Parameters relevant to the network request
Properties
| Name |
Type |
Attributes |
Description |
timeout |
number
|
<optional>
|
Request timeout (in milliseconds) |
|
Returns:
-
Type
-
Promise
(inner) getQuizResults(quizId, parameters, networkParametersopt) → {Promise}
- Description:
- Retrieve quiz recommendation and filter expression from Constructor.io API
- Source:
- See:
-
Example
constructorio.quizzes.getQuizResults('quizId', {
answers: [[1,2],[1]],
section: '123',
quizVersionId: '123',
quizSessionId: '234'
});
Parameters:
| Name |
Type |
Attributes |
Description |
quizId |
string
|
|
The identifier of the quiz |
parameters |
string
|
|
Additional parameters to refine result set
Properties
| Name |
Type |
Attributes |
Description |
answers |
array
|
|
An array of answers in the format [[1,2],[1]] |
section |
string
|
<optional>
|
Product catalog section |
quizVersionId |
string
|
<optional>
|
Version identifier for the quiz. Version ID will be returned with the first request and it should be passed with subsequent requests. More information can be found: https://docs.constructor.io/rest_api/quiz/using_quizzes/#quiz-versioning |
quizSessionId |
string
|
<optional>
|
Session identifier for the quiz. Session ID will be returned with the first request and it should be passed with subsequent requests. More information can be found: https://docs.constructor.io/rest_api/quiz/using_quizzes/#quiz-sessions |
page |
number
|
<optional>
|
The page number of the results |
resultsPerPage |
number
|
<optional>
|
The number of results per page to return |
filters |
object
|
<optional>
|
Key / value mapping (dictionary) of filters used to refine results |
fmtOptions |
object
|
<optional>
|
Key / value mapping (dictionary) of options used for result formatting |
hiddenFields |
Array.<string>
|
<optional>
|
Hidden metadata fields to return |
|
networkParameters |
object
|
<optional>
|
Parameters relevant to the network request
Properties
| Name |
Type |
Attributes |
Description |
timeout |
number
|
<optional>
|
Request timeout (in milliseconds) |
|
Returns:
-
Type
-
Promise
(inner) getQuizResultsConfig(quizId, parameters, networkParametersopt) → {Promise}
- Description:
- Retrieve quiz results page configuration from Constructor.io API
- Source:
Example
constructorio.quizzes.getQuizResultsConfig('quizId', {
quizVersionId: '123',
});
Parameters:
| Name |
Type |
Attributes |
Description |
quizId |
string
|
|
The identifier of the quiz |
parameters |
string
|
|
Additional parameters
Properties
| Name |
Type |
Attributes |
Description |
section |
string
|
<optional>
|
Product catalog section |
quizVersionId |
string
|
<optional>
|
Version identifier for the quiz. Version ID will be returned with the first request and it should be passed with subsequent requests. More information can be found: https://docs.constructor.io/rest_api/quiz/using_quizzes/#quiz-versioning |
|
networkParameters |
object
|
<optional>
|
Parameters relevant to the network request
Properties
| Name |
Type |
Attributes |
Description |
timeout |
number
|
<optional>
|
Request timeout (in milliseconds) |
|
Returns:
-
Type
-
Promise