GET PlanCare2Api/Questionnaires/Questionnaires/{questionnaireGuid}

Gets questionnaire by guid.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
questionnaireGuid

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Questionnaire.

Questionnaire
NameDescriptionTypeAdditional information
Guid

Guid.

globally unique identifier

None.

Name

Name.

string

None.

Description

Description.

string

None.

Version

Version.

string

None.

QuestionCategories

QuestionCategories (root categories only; recursive; ranked).

Collection of QuestionnaireQuestionCategory

None.

Questions

Questions (redundant; ranked).

Collection of QuestionnaireQuestion

None.

Response Formats

application/json, text/json

Sample:
{
  "Guid": "68efa1d0-52d0-4187-bb8b-e4b42dbbd11a",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Version": "sample string 4",
  "QuestionCategories": [
    {
      "$id": "2",
      "Guid": "995db94e-fd61-4046-b085-3ab41fe30c67",
      "Rank": 2,
      "Name": "sample string 3",
      "StartCollapsed": true,
      "Questions": [
        {
          "$id": "3",
          "Guid": "8291d429-24e5-4705-ba58-5ec963132fd7",
          "Rank": 2,
          "Name": "sample string 3",
          "Code": "sample string 4",
          "Description": "sample string 5",
          "QuestionCategoryName": "sample string 6",
          "AnswerIsRequired": true,
          "AllowAnswerExplanation": true,
          "Type": 1,
          "AnswerPossibilities": [
            {
              "$id": "4",
              "Guid": "35ee1dc6-b414-493b-bbee-9af13567b95e",
              "Rank": 2,
              "Answer": "sample string 3",
              "IsDefaultValue": true,
              "IsActive": true
            },
            {
              "$ref": "4"
            }
          ],
          "QuestionText": {
            "$id": "5",
            "MaximumLength": 1,
            "DefaultValue": "sample string 1",
            "Format": true,
            "EnableSpellcheck": true
          },
          "QuestionNumber": {
            "$id": "6",
            "Decimals": 1,
            "MinimumValue": 1.0,
            "MaximumValue": 1.0,
            "DefaultValue": 1.0
          },
          "QuestionDate": {
            "$id": "7",
            "DefaultValueOption": 1,
            "CustomDefaultValue": "2026-05-26T23:17:49.0121157+02:00",
            "AllowedValueOption": 1,
            "IncludeTime": true
          }
        },
        {
          "$ref": "3"
        }
      ],
      "ChildQuestionCategories": [
        {
          "$ref": "2"
        },
        {
          "$ref": "2"
        }
      ]
    },
    {
      "$ref": "2"
    }
  ],
  "Questions": [
    {
      "$ref": "3"
    },
    {
      "$ref": "3"
    }
  ]
}

application/xml, text/xml

Sample:
<Questionnaire xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Questionnaire">
  <Description>sample string 3</Description>
  <Guid>68efa1d0-52d0-4187-bb8b-e4b42dbbd11a</Guid>
  <Name>sample string 2</Name>
  <QuestionCategories>
    <QuestionnaireQuestionCategory z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
      <ChildQuestionCategories>
        <QuestionnaireQuestionCategory z:Ref="i1" />
        <QuestionnaireQuestionCategory z:Ref="i1" />
      </ChildQuestionCategories>
      <Guid>995db94e-fd61-4046-b085-3ab41fe30c67</Guid>
      <Name>sample string 3</Name>
      <Questions>
        <QuestionnaireQuestion>
          <AllowAnswerExplanation>true</AllowAnswerExplanation>
          <AnswerIsRequired>true</AnswerIsRequired>
          <AnswerPossibilities>
            <QuestionnaireQuestionAnswerPossibility>
              <Answer>sample string 3</Answer>
              <Guid>35ee1dc6-b414-493b-bbee-9af13567b95e</Guid>
              <IsActive>true</IsActive>
              <IsDefaultValue>true</IsDefaultValue>
              <Rank>2</Rank>
            </QuestionnaireQuestionAnswerPossibility>
            <QuestionnaireQuestionAnswerPossibility>
              <Answer>sample string 3</Answer>
              <Guid>35ee1dc6-b414-493b-bbee-9af13567b95e</Guid>
              <IsActive>true</IsActive>
              <IsDefaultValue>true</IsDefaultValue>
              <Rank>2</Rank>
            </QuestionnaireQuestionAnswerPossibility>
          </AnswerPossibilities>
          <Code>sample string 4</Code>
          <Description>sample string 5</Description>
          <Guid>8291d429-24e5-4705-ba58-5ec963132fd7</Guid>
          <Name>sample string 3</Name>
          <QuestionCategoryName>sample string 6</QuestionCategoryName>
          <QuestionDate>
            <AllowedValueOption>AllDates</AllowedValueOption>
            <CustomDefaultValue>2026-05-26T23:17:49.0121157+02:00</CustomDefaultValue>
            <DefaultValueOption>NotApplicable</DefaultValueOption>
            <IncludeTime>true</IncludeTime>
          </QuestionDate>
          <QuestionNumber>
            <Decimals>1</Decimals>
            <DefaultValue>1</DefaultValue>
            <MaximumValue>1</MaximumValue>
            <MinimumValue>1</MinimumValue>
          </QuestionNumber>
          <QuestionText>
            <DefaultValue>sample string 1</DefaultValue>
            <EnableSpellcheck>true</EnableSpellcheck>
            <Format>true</Format>
            <MaximumLength>1</MaximumLength>
          </QuestionText>
          <Rank>2</Rank>
          <Type>MultipleChoice</Type>
        </QuestionnaireQuestion>
        <QuestionnaireQuestion>
          <AllowAnswerExplanation>true</AllowAnswerExplanation>
          <AnswerIsRequired>true</AnswerIsRequired>
          <AnswerPossibilities>
            <QuestionnaireQuestionAnswerPossibility>
              <Answer>sample string 3</Answer>
              <Guid>35ee1dc6-b414-493b-bbee-9af13567b95e</Guid>
              <IsActive>true</IsActive>
              <IsDefaultValue>true</IsDefaultValue>
              <Rank>2</Rank>
            </QuestionnaireQuestionAnswerPossibility>
            <QuestionnaireQuestionAnswerPossibility>
              <Answer>sample string 3</Answer>
              <Guid>35ee1dc6-b414-493b-bbee-9af13567b95e</Guid>
              <IsActive>true</IsActive>
              <IsDefaultValue>true</IsDefaultValue>
              <Rank>2</Rank>
            </QuestionnaireQuestionAnswerPossibility>
          </AnswerPossibilities>
          <Code>sample string 4</Code>
          <Description>sample string 5</Description>
          <Guid>8291d429-24e5-4705-ba58-5ec963132fd7</Guid>
          <Name>sample string 3</Name>
          <QuestionCategoryName>sample string 6</QuestionCategoryName>
          <QuestionDate>
            <AllowedValueOption>AllDates</AllowedValueOption>
            <CustomDefaultValue>2026-05-26T23:17:49.0121157+02:00</CustomDefaultValue>
            <DefaultValueOption>NotApplicable</DefaultValueOption>
            <IncludeTime>true</IncludeTime>
          </QuestionDate>
          <QuestionNumber>
            <Decimals>1</Decimals>
            <DefaultValue>1</DefaultValue>
            <MaximumValue>1</MaximumValue>
            <MinimumValue>1</MinimumValue>
          </QuestionNumber>
          <QuestionText>
            <DefaultValue>sample string 1</DefaultValue>
            <EnableSpellcheck>true</EnableSpellcheck>
            <Format>true</Format>
            <MaximumLength>1</MaximumLength>
          </QuestionText>
          <Rank>2</Rank>
          <Type>MultipleChoice</Type>
        </QuestionnaireQuestion>
      </Questions>
      <Rank>2</Rank>
      <StartCollapsed>true</StartCollapsed>
    </QuestionnaireQuestionCategory>
    <QuestionnaireQuestionCategory z:Ref="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />
  </QuestionCategories>
  <Questions>
    <QuestionnaireQuestion>
      <AllowAnswerExplanation>true</AllowAnswerExplanation>
      <AnswerIsRequired>true</AnswerIsRequired>
      <AnswerPossibilities>
        <QuestionnaireQuestionAnswerPossibility>
          <Answer>sample string 3</Answer>
          <Guid>35ee1dc6-b414-493b-bbee-9af13567b95e</Guid>
          <IsActive>true</IsActive>
          <IsDefaultValue>true</IsDefaultValue>
          <Rank>2</Rank>
        </QuestionnaireQuestionAnswerPossibility>
        <QuestionnaireQuestionAnswerPossibility>
          <Answer>sample string 3</Answer>
          <Guid>35ee1dc6-b414-493b-bbee-9af13567b95e</Guid>
          <IsActive>true</IsActive>
          <IsDefaultValue>true</IsDefaultValue>
          <Rank>2</Rank>
        </QuestionnaireQuestionAnswerPossibility>
      </AnswerPossibilities>
      <Code>sample string 4</Code>
      <Description>sample string 5</Description>
      <Guid>8291d429-24e5-4705-ba58-5ec963132fd7</Guid>
      <Name>sample string 3</Name>
      <QuestionCategoryName>sample string 6</QuestionCategoryName>
      <QuestionDate>
        <AllowedValueOption>AllDates</AllowedValueOption>
        <CustomDefaultValue>2026-05-26T23:17:49.0121157+02:00</CustomDefaultValue>
        <DefaultValueOption>NotApplicable</DefaultValueOption>
        <IncludeTime>true</IncludeTime>
      </QuestionDate>
      <QuestionNumber>
        <Decimals>1</Decimals>
        <DefaultValue>1</DefaultValue>
        <MaximumValue>1</MaximumValue>
        <MinimumValue>1</MinimumValue>
      </QuestionNumber>
      <QuestionText>
        <DefaultValue>sample string 1</DefaultValue>
        <EnableSpellcheck>true</EnableSpellcheck>
        <Format>true</Format>
        <MaximumLength>1</MaximumLength>
      </QuestionText>
      <Rank>2</Rank>
      <Type>MultipleChoice</Type>
    </QuestionnaireQuestion>
    <QuestionnaireQuestion>
      <AllowAnswerExplanation>true</AllowAnswerExplanation>
      <AnswerIsRequired>true</AnswerIsRequired>
      <AnswerPossibilities>
        <QuestionnaireQuestionAnswerPossibility>
          <Answer>sample string 3</Answer>
          <Guid>35ee1dc6-b414-493b-bbee-9af13567b95e</Guid>
          <IsActive>true</IsActive>
          <IsDefaultValue>true</IsDefaultValue>
          <Rank>2</Rank>
        </QuestionnaireQuestionAnswerPossibility>
        <QuestionnaireQuestionAnswerPossibility>
          <Answer>sample string 3</Answer>
          <Guid>35ee1dc6-b414-493b-bbee-9af13567b95e</Guid>
          <IsActive>true</IsActive>
          <IsDefaultValue>true</IsDefaultValue>
          <Rank>2</Rank>
        </QuestionnaireQuestionAnswerPossibility>
      </AnswerPossibilities>
      <Code>sample string 4</Code>
      <Description>sample string 5</Description>
      <Guid>8291d429-24e5-4705-ba58-5ec963132fd7</Guid>
      <Name>sample string 3</Name>
      <QuestionCategoryName>sample string 6</QuestionCategoryName>
      <QuestionDate>
        <AllowedValueOption>AllDates</AllowedValueOption>
        <CustomDefaultValue>2026-05-26T23:17:49.0121157+02:00</CustomDefaultValue>
        <DefaultValueOption>NotApplicable</DefaultValueOption>
        <IncludeTime>true</IncludeTime>
      </QuestionDate>
      <QuestionNumber>
        <Decimals>1</Decimals>
        <DefaultValue>1</DefaultValue>
        <MaximumValue>1</MaximumValue>
        <MinimumValue>1</MinimumValue>
      </QuestionNumber>
      <QuestionText>
        <DefaultValue>sample string 1</DefaultValue>
        <EnableSpellcheck>true</EnableSpellcheck>
        <Format>true</Format>
        <MaximumLength>1</MaximumLength>
      </QuestionText>
      <Rank>2</Rank>
      <Type>MultipleChoice</Type>
    </QuestionnaireQuestion>
  </Questions>
  <Version>sample string 4</Version>
</Questionnaire>