GET PlanCare2Api/Questionnaires/FilledQuestionnaires/{questionnaireGuid}/Chapters

Gets the questionnaire chapters for the specified questionnaire.

Request Information

URI Parameters

Name Description Type Additional information
questionnaireGuid

The guid of the questionnaire.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

The questionnaire chapters for the specified questionnaire.

Collection of QuestionnaireChapter
Name Description Type Additional information
Guid

The id of the questionnaire chapter.

globally unique identifier

-

Name

The name of the questionnaire chapter.

string

-

QuestionnaireGuid

The id of the questionnaire to which the chapter belongs.

globally unique identifier

-

HideUnansweredQuestions

Determines whether unanswered questions are shown.

boolean

-

VisibleOnCarePlan

Determines whether the chapter is shown on the careplan.

boolean

-

VisibleOnClientCard

Determines whether the chapter is shown in the clientcard.

boolean

-

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Guid": "8c9cdced-0650-4a08-bc3a-a64ef1fbf0ec",
    "Name": "sample string 2",
    "QuestionnaireGuid": "b4364009-0d88-4f74-8ef5-94ded647d90b",
    "HideUnansweredQuestions": true,
    "VisibleOnCarePlan": true,
    "VisibleOnClientCard": true
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfQuestionnaireChapter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Questionnaire">
  <QuestionnaireChapter>
    <Guid>8c9cdced-0650-4a08-bc3a-a64ef1fbf0ec</Guid>
    <HideUnansweredQuestions>true</HideUnansweredQuestions>
    <Name>sample string 2</Name>
    <QuestionnaireGuid>b4364009-0d88-4f74-8ef5-94ded647d90b</QuestionnaireGuid>
    <VisibleOnCarePlan>true</VisibleOnCarePlan>
    <VisibleOnClientCard>true</VisibleOnClientCard>
  </QuestionnaireChapter>
  <QuestionnaireChapter>
    <Guid>8c9cdced-0650-4a08-bc3a-a64ef1fbf0ec</Guid>
    <HideUnansweredQuestions>true</HideUnansweredQuestions>
    <Name>sample string 2</Name>
    <QuestionnaireGuid>b4364009-0d88-4f74-8ef5-94ded647d90b</QuestionnaireGuid>
    <VisibleOnCarePlan>true</VisibleOnCarePlan>
    <VisibleOnClientCard>true</VisibleOnClientCard>
  </QuestionnaireChapter>
</ArrayOfQuestionnaireChapter>