Participant
Work with a Participant. Requires Participant Key
| API | Description |
|---|---|
| GET v1/Participant |
Return top level information about a Participant |
| GET v1/Participant/{id} |
Retrieves a Participant by their id |
| POST v1/Participant |
Creates a Participant |
| PUT v1/Participant/{id} |
Creates a new participant or updates an existing participant. |
Debug
Debug the service itself. Check online status, authentication, server time, etc.
| API | Description |
|---|---|
| POST v1/debug/AnonymousPing |
Returns true, no authentication required |
| POST v1/debug/Time |
Returns site time, authentication required |
| POST v1/debug/AuthenticatedPing |
Returns true, authentication required |
| POST v1/debug/ErrorPreview |
Generates a handled error and returns it |
| POST v1/debug/ServerErrorPreview |
Throws an unhandled error |
| POST v1/debug/WhoAmI |
Displays the name of the authenticated client |
HighLevelQuizSummary
Returns a High Level Quiz Summary
| API | Description |
|---|---|
| GET v1/highLevelQuizSummaries |
Returns an array of all HighLevelQuizSummaries |
| GET v1/highLevelQuizSummaries/{id} |
Retrieves a HighLevelQuizSummary by the quizId |
| GET v1/highLevelQuizSummaries/{id}/Excel/Participant/{pid} |
Retrieves a HighLevelQuizSummary as Excel download by the quizId |
ParticipantQuizList
Work with ParticipantQuizListzes.
| API | Description |
|---|---|
| GET v1/participantQuizList/{id} |
Returns an array of all QuizListSummaries for a Participant by their id |
| GET v1/participantQuizList/{id}/quizzes/{quizId} |
Retrieves a ParticipantQuizList by the Participant Id and Quiz Id |
QuizGroup
Work with QuizGroups.
| API | Description |
|---|---|
| GET v1/quizGroups |
Returns an array of all QuizGroups |
| GET v1/quizGroups/{id} |
Retrieves a QuizGroup by their id |
| POST v1/quizGroups |
Creates a QuizGroup |
| PUT v1/quizGroups/{id} |
Creates a new quiz group or updates an existing quiz group |
| GET v1/quizGroups/{id}/quizzes |
Returns an array of all Quizzes for a QuizGroup |
| POST v1/quizGroups/{id}/add-quizzes |
Adds quizzes to a quiz group. |
| POST v1/quizGroups/{id}/remove-quizzes |
Removes quizzes from a quiz group. |
Client
Work with Clients.
| API | Description |
|---|---|
| GET v1/clients |
Returns an array of all clients |
| GET v1/clients/{id} |
Retrieves a client by their id |
| GET v1/clients/{id}/keys |
Retrieves all client keys for a client by their id |
| POST v1/clients/{id}/create-clientkey |
Add new Client Key to Client |
| POST v1/clients/{id}/remove-clientkey |
Remove Client Key to Client |
| POST v1/clients |
Creates a client |
| PUT v1/clients/{id} |
Creates a new client or updates an existing client |
Theme
Work with themes.
| API | Description |
|---|---|
| GET v1/themes |
Returns an array of all themes |
| GET v1/themes/{id} |
Retrieves a theme by their id |
| POST v1/themes |
Creates a theme |
| PUT v1/themes/{id} |
Creates a new theme or updates an existing theme |
| GET v1/themes/{cid}/{id}/companyLogo |
Get a CompanyLogo.png |
| GET v1/themes/{clientid}/{id}/programLogo |
Get a ProgramLogo.png |
| POST v1/themes/{id}/upload-companyLogo |
Upload a Company Logo to a Theme |
| POST v1/themes/{id}/upload-programLogo |
Upload a Program Logo to a Theme |
Take
Work with a take. Requires Take Key
| API | Description |
|---|---|
| GET v1/take |
Return top level information about a Take |
| GET v1/take/sections/{id} |
Return a Take Section A Take Section contains any number of Questions, Html and other Sections |
| GET v1/take/questionMultipleChoiceSingleSelects/{id} |
Return a Take Question - Multiple Choice, Single Select A Take Question - Multiple Choice, Single Select contains the question, the available answers, and the selected answer |
| POST v1/take/questionMultipleChoiceSingleSelects/{id}/set-answer |
Return a Take Question - Multiple Choice, Single Select A Take Question - Multiple Choice, Single Select contains the question, the available answers, and the selected answer |
| GET v1/take/questionEssays/{id} |
Return a Take Question - Multiple Choice, Single Select A Take Question - Multiple Choice, Single Select contains the question, the available answers, and the selected answer |
| POST v1/take/questionEssays/{id}/set-answer |
Return a Take Question - Multiple Choice, Single Select A Take Question - Multiple Choice, Single Select contains the question, the available answers, and the selected answer |
| POST v1/take/start-take |
Start a Take of a Quiz. |
| POST v1/take/finish-take |
Finish a Take of a Quiz. |
| GET v1/take/stylesheet/{takekey} |
Returns a theme custom stylesheet for a take |
| GET v1/take/companyLogo/{takeKey} |
Get a CompanyLogo.png for take |
| GET v1/take/programLogo/{takeKey} |
Get a ProgramLogo.png for take |
AnswerSelectSet
Work with AnswerSelectSets.
| API | Description |
|---|---|
| GET v1/answerSelectSets |
Returns an array of all AnswerSelectSets |
| GET v1/answerSelectSets/{id} |
Retrieves a AnswerSelectSet by their id |
| POST v1/answerSelectSets |
Creates a AnswerSelectSet |
| POST v1/answerSelectSets/{id}/AnswerSelectSetNodes |
Creates a AnswerSelectSetNode in a AnswerSelectSet |
| PUT v1/answerSelectSets/{id} |
Creates a new AnswerSelectSet or updates an existing AnswerSelectSet |
| PUT v1/answerSelectSets/{id}/AnswerSelectSetNodes/{nid} |
Creates a new AnswerSelectSetNode in a AnswerSelectSet or updates an existing AnswerSelectSetNode in a AnswerSelectSet |
| GET v1/answerSelectSets/{id}/AnswerSelectSetNodes |
Returns an array of all AnswerSelectSetNode for a AnswerSelectSet |
| GET v1/answerSelectSets/{id}/AnswerSelectSetNodes/{nid} |
Retrieves a AnswerSelectSetNode by their id |
| GET v1/answerSelectSets/{id}/AnswerSelectSetNodeInfos |
Returns an array of all AnswerSelectSetNodeInfos for a AnswerSelectSet |
| GET v1/answerSelectSets/{id}/AnswerSelectSetNodeInfos/{nid} |
Retrieves a AnswerSelectSetNodeInfo by their id |
| DELETE v1/answerSelectSets/{id}/AnswerSelectSetNodes/{nid} |
Creates a new AnswerSelectSetNode in a AnswerSelectSet or updates an existing AnswerSelectSetNode in a AnswerSelectSet |
AnswerSelect
Work with AnswerSelects.
| API | Description |
|---|---|
| GET v1/answerselects |
Returns an array of all AnswerSelects |
| GET v1/answerselects/{id} |
Retrieves a AnswerSelect by its id |
| POST v1/answerselects |
Creates a AnswerSelect |
| PUT v1/answerselects/{id} |
Creates a new AnswerSelect or updates an existing AnswerSelect |
Quiz
Work with Quizzes.
| API | Description |
|---|---|
| GET v1/quizzes |
Returns an array of all Quizzes |
| GET v1/quizzes/{id} |
Retrieves a Quiz by their id |
| POST v1/quizzes |
Creates a Quiz |
| PUT v1/quizzes/{id} |
Creates a new quiz or updates an existing quiz |
QuizResultSummary
Returns a participant-level summary for a single quiz
| API | Description |
|---|---|
| GET v1/quizResultSummary |
Retrieves a QuizResultSummary by the takeKey |
Exception
| API | Description |
|---|---|
| POST v1/Exception/LogJavaScriptError |
No documentation available. |
QuestionMultipleChoiceSingleSelect
Work with QuestionMultipleChoiceSingleSelects.
| API | Description |
|---|---|
| GET v1/QuestionMultipleChoiceSingleSelects |
Returns an array of all QuestionMultipleChoiceSingleSelects |
| GET v1/QuestionMultipleChoiceSingleSelects/{id} |
Retrieves a QuestionMultipleChoiceSingleSelect by their id |
| POST v1/QuestionMultipleChoiceSingleSelects |
Creates a QuestionMultipleChoiceSingleSelect |
| PUT v1/QuestionMultipleChoiceSingleSelects/{id} |
Creates a new QuestionMultipleChoiceSingleSelect or updates an existing QuestionMultipleChoiceSingleSelect |
QuizSection
Work with QuizSections.
| API | Description |
|---|---|
| GET v1/quizSections |
Returns an array of all QuizSections |
| GET v1/quizSections/{id} |
Retrieves a QuizSection by their id |
| POST v1/quizSections |
Creates a QuizSection |
| POST v1/quizSections/{id}/quizSectionNodes |
Creates a QuizSectionNode in a QuizSection |
| PUT v1/quizSections/{id} |
Creates a new Quiz Section or updates an existing Quiz Section |
| PUT v1/quizSections/{id}/quizSectionNodes/{nid} |
Creates a new QuizSectionNode in a QuizSection or updates an existing QuizSectionNode in a QuizSection |
| GET v1/quizSections/{id}/quizSectionNodes |
Returns an array of all QuizSectionNode for a QuizSection |
| GET v1/quizSections/{id}/quizSectionNodes/{nid} |
Retrieves a QuizSectionNode by their id |
| GET v1/quizSections/{id}/quizSectionNodeInfos |
Returns an array of all QuizSectionNodeInfo for a QuizSection |
| GET v1/quizSections/{id}/quizSectionNodeInfos/{nid} |
Retrieves a QuizSectionNodeInfo by their id |
| DELETE v1/quizSections/{id}/quizSectionNodes/{nid} |
Creates a new QuizSectionNode in a QuizSection or updates an existing QuizSectionNode in a QuizSection |
Takes
Work with a takes. Requires Client Authentication
| API | Description |
|---|---|
| POST v1/takes/request-take |
Request a Take of a Quiz. |
| POST v1/takes/request-retake |
Request a Retake of a Quiz. |
| GET v1/takes?participantId={participantId}&latest={latest} |
No documentation available. |
QuestionEssay
Work with QuestionEssays.
| API | Description |
|---|---|
| GET v1/QuestionEssays |
Returns an array of all QuestionEssays |
| GET v1/QuestionEssays/{id} |
Retrieves a QuestionEssay by their id |
| POST v1/QuestionEssays |
Creates a QuestionEssay |
| PUT v1/QuestionEssays/{id} |
Creates a new QuestionEssay or updates an existing QuestionEssay |
QuizDetailReport
Work with QuizDetailReports.
| API | Description |
|---|---|
| GET v1/quizDetailReports/{quizSourceId} |
Returns an array of all QuizDetailReports |
| GET v1/quizDetailReports/{id}/Excel/Participant/{pid} |
Retrieves a QuizDetailReport as Excel download by the quizId |
QuizListSummary
Work with QuizListSummaryzes.
| API | Description |
|---|---|
| GET v1/quizListSummaries |
Returns an array of all QuizListSummaries |
| GET v1/quizListSummaries/{id} |
Retrieves a QuizListSummary by their id |