GET api/users/user/{userId}/getQuestionnaires

Get user questionnaires.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userId

A user id.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of UserQuestionnaireGroup
NameDescriptionTypeAdditional information
IsAssigned

Is questionnaire group assigned to the learner.

 boolean

None.
Questionnaires

List of all available questionnaires

 Collection of Questionnaire

None.
QuestionnaireGroupID

Questionnaire group id

 integer

None.
QuestionnaireGroupName

Questionnaire group name

 string

None.
QuestionnaireGroupIcon

Questionnaire group icon

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "IsAssigned": true,
    "Questionnaires": [
      {
        "QuestionnaireID": 1,
        "QuestionnaireName": "sample string 2",
        "IsQuestionnaireActive": true,
        "IsQuestionnaireCompleted": true
      },
      {
        "QuestionnaireID": 1,
        "QuestionnaireName": "sample string 2",
        "IsQuestionnaireActive": true,
        "IsQuestionnaireCompleted": true
      }
    ],
    "QuestionnaireGroupID": 2,
    "QuestionnaireGroupName": "sample string 3",
    "QuestionnaireGroupIcon": "sample string 4"
  },
  {
    "IsAssigned": true,
    "Questionnaires": [
      {
        "QuestionnaireID": 1,
        "QuestionnaireName": "sample string 2",
        "IsQuestionnaireActive": true,
        "IsQuestionnaireCompleted": true
      },
      {
        "QuestionnaireID": 1,
        "QuestionnaireName": "sample string 2",
        "IsQuestionnaireActive": true,
        "IsQuestionnaireCompleted": true
      }
    ],
    "QuestionnaireGroupID": 2,
    "QuestionnaireGroupName": "sample string 3",
    "QuestionnaireGroupIcon": "sample string 4"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfUserQuestionnaireGroup xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UserQuestionnaireGroup>
    <QuestionnaireGroupID>2</QuestionnaireGroupID>
    <QuestionnaireGroupName>sample string 3</QuestionnaireGroupName>
    <QuestionnaireGroupIcon>sample string 4</QuestionnaireGroupIcon>
    <IsAssigned>true</IsAssigned>
    <Questionnaires>
      <Questionnaire>
        <QuestionnaireID>1</QuestionnaireID>
        <QuestionnaireName>sample string 2</QuestionnaireName>
        <IsQuestionnaireActive>true</IsQuestionnaireActive>
        <IsQuestionnaireCompleted>true</IsQuestionnaireCompleted>
      </Questionnaire>
      <Questionnaire>
        <QuestionnaireID>1</QuestionnaireID>
        <QuestionnaireName>sample string 2</QuestionnaireName>
        <IsQuestionnaireActive>true</IsQuestionnaireActive>
        <IsQuestionnaireCompleted>true</IsQuestionnaireCompleted>
      </Questionnaire>
    </Questionnaires>
  </UserQuestionnaireGroup>
  <UserQuestionnaireGroup>
    <QuestionnaireGroupID>2</QuestionnaireGroupID>
    <QuestionnaireGroupName>sample string 3</QuestionnaireGroupName>
    <QuestionnaireGroupIcon>sample string 4</QuestionnaireGroupIcon>
    <IsAssigned>true</IsAssigned>
    <Questionnaires>
      <Questionnaire>
        <QuestionnaireID>1</QuestionnaireID>
        <QuestionnaireName>sample string 2</QuestionnaireName>
        <IsQuestionnaireActive>true</IsQuestionnaireActive>
        <IsQuestionnaireCompleted>true</IsQuestionnaireCompleted>
      </Questionnaire>
      <Questionnaire>
        <QuestionnaireID>1</QuestionnaireID>
        <QuestionnaireName>sample string 2</QuestionnaireName>
        <IsQuestionnaireActive>true</IsQuestionnaireActive>
        <IsQuestionnaireCompleted>true</IsQuestionnaireCompleted>
      </Questionnaire>
    </Questionnaires>
  </UserQuestionnaireGroup>
</ArrayOfUserQuestionnaireGroup>