GET api/results/questionnaire/{userId}/byQuestionnaireGroup?page={page}&recordsPerPage={recordsPerPage}&questionnaireGroupId={questionnaireGroupId}

Get questionnaire results for the user and questionnaire group.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userId

User Id.

 integer

Required
page

Page number.

 integer

Required
recordsPerPage

Records per page.

 integer

Required
questionnaireGroupId

Questionnaire Group ID.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

QuestionnaireResultCollection
NameDescriptionTypeAdditional information
QuestionnaireResults

Collection of Questionnaire Result

 Collection of QuestionnaireResult

None.
Pagination

Pagination

 Pagination

None.

Response Formats

application/json, text/json

Sample: 
{
  "QuestionnaireResults": [
    {
      "SessionId": 1,
      "ResultDate": "2024-09-21T02:46:43.2128501+00:00",
      "QuestionnaireID": 3,
      "QuestionnaireName": "sample string 4",
      "QuestionnaireGroupID": 5,
      "QuestionnaireGroupName": "sample string 6",
      "ActionText": "sample string 7",
      "ResultDataItems": [
        {
          "DataItemName": "sample string 1",
          "DataItemValue": "sample string 2"
        },
        {
          "DataItemName": "sample string 1",
          "DataItemValue": "sample string 2"
        }
      ]
    },
    {
      "SessionId": 1,
      "ResultDate": "2024-09-21T02:46:43.2128501+00:00",
      "QuestionnaireID": 3,
      "QuestionnaireName": "sample string 4",
      "QuestionnaireGroupID": 5,
      "QuestionnaireGroupName": "sample string 6",
      "ActionText": "sample string 7",
      "ResultDataItems": [
        {
          "DataItemName": "sample string 1",
          "DataItemValue": "sample string 2"
        },
        {
          "DataItemName": "sample string 1",
          "DataItemValue": "sample string 2"
        }
      ]
    }
  ],
  "Pagination": {
    "CurrentPage": 1,
    "TotalRecords": 2,
    "RecordsPerPage": 3
  }
}

application/xml, text/xml

Sample: 
<QuestionnaireResultCollection xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <QuestionnaireResults>
    <QuestionnaireResult>
      <SessionId>1</SessionId>
      <ResultDate>2024-09-21T02:46:43.2128501+00:00</ResultDate>
      <QuestionnaireID>3</QuestionnaireID>
      <QuestionnaireName>sample string 4</QuestionnaireName>
      <QuestionnaireGroupID>5</QuestionnaireGroupID>
      <QuestionnaireGroupName>sample string 6</QuestionnaireGroupName>
      <ActionText>sample string 7</ActionText>
      <ResultDataItems>
        <ResultDataItem>
          <DataItemName>sample string 1</DataItemName>
          <DataItemValue>sample string 2</DataItemValue>
        </ResultDataItem>
        <ResultDataItem>
          <DataItemName>sample string 1</DataItemName>
          <DataItemValue>sample string 2</DataItemValue>
        </ResultDataItem>
      </ResultDataItems>
    </QuestionnaireResult>
    <QuestionnaireResult>
      <SessionId>1</SessionId>
      <ResultDate>2024-09-21T02:46:43.2128501+00:00</ResultDate>
      <QuestionnaireID>3</QuestionnaireID>
      <QuestionnaireName>sample string 4</QuestionnaireName>
      <QuestionnaireGroupID>5</QuestionnaireGroupID>
      <QuestionnaireGroupName>sample string 6</QuestionnaireGroupName>
      <ActionText>sample string 7</ActionText>
      <ResultDataItems>
        <ResultDataItem>
          <DataItemName>sample string 1</DataItemName>
          <DataItemValue>sample string 2</DataItemValue>
        </ResultDataItem>
        <ResultDataItem>
          <DataItemName>sample string 1</DataItemName>
          <DataItemValue>sample string 2</DataItemValue>
        </ResultDataItem>
      </ResultDataItems>
    </QuestionnaireResult>
  </QuestionnaireResults>
  <Pagination>
    <CurrentPage>1</CurrentPage>
    <TotalRecords>2</TotalRecords>
    <RecordsPerPage>3</RecordsPerPage>
  </Pagination>
</QuestionnaireResultCollection>