GET PlanCare2Api/Questionnaires/Questionnaires/{questionnaireGuid}

Gets questionnaire by guid.

Request Information

URI Parameters

Name	Description	Type	Additional information
questionnaireGuid		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Questionnaire.

Questionnaire

Name	Description	Type	Additional information
Guid	Guid.	globally unique identifier	-
Name	Name.	string	-
Description	Description.	string	-
Version	Version.	string	-
DefaultViewType	DefaultViewType.	QuestionnaireViewType	-
PossibleViewTypes	PossibleViewTypes.	Collection of QuestionnaireViewType	-
DefaultNavigationMenuType	DefaultNavigationMenuType.	QuestionnaireNavigationMenuType	-
ShowQuestionCode	ShowQuestionCode.	boolean	-
ShowSubQuestionsInPopup	ShowSubQuestionsInPopup.	boolean	-
ShowTabOverviewAnswers	ShowTabOverviewAnswers.	boolean	-
ShowTabProperties	ShowTabProperties.	boolean	-
QuestionCategories	QuestionCategories (root categories only; recursive; ranked).	Collection of QuestionnaireQuestionCategory	-
Questions	Questions (redundant; ranked).	Collection of QuestionnaireQuestion	-

Response Formats

application/json, text/json

Sample:

{
  "Guid": "ee439d89-13cb-4dc4-8a50-0f25c764b7a5",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Version": "sample string 4",
  "DefaultViewType": 0,
  "PossibleViewTypes": [
    0,
    0
  ],
  "DefaultNavigationMenuType": 0,
  "ShowQuestionCode": true,
  "ShowSubQuestionsInPopup": true,
  "ShowTabOverviewAnswers": true,
  "ShowTabProperties": true,
  "QuestionCategories": [
    {
      "$id": "2",
      "Guid": "ccf56c5f-9abe-4636-a27e-bb92ee565a06",
      "Rank": 2,
      "Name": "sample string 3",
      "StartCollapsed": true,
      "Questions": [
        {
          "$id": "3",
          "Guid": "4613d2a2-1e01-47d5-af8d-5d4e361348f7",
          "Rank": 2,
          "Type": 1,
          "Name": "sample string 3",
          "Code": "sample string 4",
          "Description": "sample string 5",
          "Image": "sample string 6",
          "QuestionCategoryName": "sample string 7",
          "AnswerIsRequired": true,
          "AllowAnswerExplanation": true,
          "NavigationOption": 0,
          "NextQuestionGuid": "f2e995c8-e1ea-4665-9eab-5d0fda8a7a37",
          "IsSubQuestion": true,
          "AnswerPossibilities": [
            {
              "$id": "4",
              "Guid": "6bd053c1-d13e-4445-af1a-ee78f206cd8e",
              "Rank": 2,
              "Answer": "sample string 3",
              "Description": "sample string 4",
              "IsDefaultValue": true,
              "IsActive": true,
              "NavigationOption": 0,
              "NextQuestionGuid": "30406688-d00e-4317-8881-80d74d8b75b9",
              "Image": "sample string 7",
              "SubQuestionGuids": [
                "c46f6a99-5d17-45ae-aa1d-d00374d6fece",
                "8b956065-1bc8-4a41-a01e-e8985068fc58"
              ]
            },
            {
              "$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-26T22:06:54.9478594+02:00",
            "AllowedValueOption": 1,
            "IncludeTime": true
          },
          "QuestionEmployeeSelection": {
            "$id": "8",
            "MinimumEmployees": 1,
            "MaximumEmployees": 1
          },
          "QuestionClientSelection": {
            "$id": "9",
            "MinimumClients": 1,
            "MaximumClients": 1
          },
          "QuestionCorrelationSelection": {
            "$id": "10",
            "MinimumCorrelations": 1,
            "MaximumCorrelations": 1
          },
          "QuestionOrganizationEntitySelection": {
            "$id": "11",
            "MinimumOrganizationEntities": 1,
            "MaximumOrganizationEntities": 1
          }
        },
        {
          "$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">
  <DefaultNavigationMenuType>Hidden</DefaultNavigationMenuType>
  <DefaultViewType>Form</DefaultViewType>
  <Description>sample string 3</Description>
  <Guid>ee439d89-13cb-4dc4-8a50-0f25c764b7a5</Guid>
  <Name>sample string 2</Name>
  <PossibleViewTypes>
    <QuestionnaireViewType>Form</QuestionnaireViewType>
    <QuestionnaireViewType>Form</QuestionnaireViewType>
  </PossibleViewTypes>
  <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>ccf56c5f-9abe-4636-a27e-bb92ee565a06</Guid>
      <Name>sample string 3</Name>
      <Questions>
        <QuestionnaireQuestion>
          <AllowAnswerExplanation>true</AllowAnswerExplanation>
          <AnswerIsRequired>true</AnswerIsRequired>
          <AnswerPossibilities>
            <QuestionnaireQuestionAnswerPossibility>
              <Answer>sample string 3</Answer>
              <Description>sample string 4</Description>
              <Guid>6bd053c1-d13e-4445-af1a-ee78f206cd8e</Guid>
              <Image>sample string 7</Image>
              <IsActive>true</IsActive>
              <IsDefaultValue>true</IsDefaultValue>
              <NavigationOption>NextQuestion</NavigationOption>
              <NextQuestionGuid>30406688-d00e-4317-8881-80d74d8b75b9</NextQuestionGuid>
              <Rank>2</Rank>
              <SubQuestionGuids xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:guid>c46f6a99-5d17-45ae-aa1d-d00374d6fece</d8p1:guid>
                <d8p1:guid>8b956065-1bc8-4a41-a01e-e8985068fc58</d8p1:guid>
              </SubQuestionGuids>
            </QuestionnaireQuestionAnswerPossibility>
            <QuestionnaireQuestionAnswerPossibility>
              <Answer>sample string 3</Answer>
              <Description>sample string 4</Description>
              <Guid>6bd053c1-d13e-4445-af1a-ee78f206cd8e</Guid>
              <Image>sample string 7</Image>
              <IsActive>true</IsActive>
              <IsDefaultValue>true</IsDefaultValue>
              <NavigationOption>NextQuestion</NavigationOption>
              <NextQuestionGuid>30406688-d00e-4317-8881-80d74d8b75b9</NextQuestionGuid>
              <Rank>2</Rank>
              <SubQuestionGuids xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:guid>c46f6a99-5d17-45ae-aa1d-d00374d6fece</d8p1:guid>
                <d8p1:guid>8b956065-1bc8-4a41-a01e-e8985068fc58</d8p1:guid>
              </SubQuestionGuids>
            </QuestionnaireQuestionAnswerPossibility>
          </AnswerPossibilities>
          <Code>sample string 4</Code>
          <Description>sample string 5</Description>
          <Guid>4613d2a2-1e01-47d5-af8d-5d4e361348f7</Guid>
          <Image>sample string 6</Image>
          <IsSubQuestion>true</IsSubQuestion>
          <Name>sample string 3</Name>
          <NavigationOption>NextQuestion</NavigationOption>
          <NextQuestionGuid>f2e995c8-e1ea-4665-9eab-5d0fda8a7a37</NextQuestionGuid>
          <QuestionCategoryName>sample string 7</QuestionCategoryName>
          <QuestionClientSelection>
            <MaximumClients>1</MaximumClients>
            <MinimumClients>1</MinimumClients>
          </QuestionClientSelection>
          <QuestionCorrelationSelection>
            <MaximumCorrelations>1</MaximumCorrelations>
            <MinimumCorrelations>1</MinimumCorrelations>
          </QuestionCorrelationSelection>
          <QuestionDate>
            <AllowedValueOption>AllDates</AllowedValueOption>
            <CustomDefaultValue>2026-05-26T22:06:54.9478594+02:00</CustomDefaultValue>
            <DefaultValueOption>NotApplicable</DefaultValueOption>
            <IncludeTime>true</IncludeTime>
          </QuestionDate>
          <QuestionEmployeeSelection>
            <MaximumEmployees>1</MaximumEmployees>
            <MinimumEmployees>1</MinimumEmployees>
          </QuestionEmployeeSelection>
          <QuestionNumber>
            <Decimals>1</Decimals>
            <DefaultValue>1</DefaultValue>
            <MaximumValue>1</MaximumValue>
            <MinimumValue>1</MinimumValue>
          </QuestionNumber>
          <QuestionOrganizationEntitySelection>
            <MaximumOrganizationEntities>1</MaximumOrganizationEntities>
            <MinimumOrganizationEntities>1</MinimumOrganizationEntities>
          </QuestionOrganizationEntitySelection>
          <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>
              <Description>sample string 4</Description>
              <Guid>6bd053c1-d13e-4445-af1a-ee78f206cd8e</Guid>
              <Image>sample string 7</Image>
              <IsActive>true</IsActive>
              <IsDefaultValue>true</IsDefaultValue>
              <NavigationOption>NextQuestion</NavigationOption>
              <NextQuestionGuid>30406688-d00e-4317-8881-80d74d8b75b9</NextQuestionGuid>
              <Rank>2</Rank>
              <SubQuestionGuids xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:guid>c46f6a99-5d17-45ae-aa1d-d00374d6fece</d8p1:guid>
                <d8p1:guid>8b956065-1bc8-4a41-a01e-e8985068fc58</d8p1:guid>
              </SubQuestionGuids>
            </QuestionnaireQuestionAnswerPossibility>
            <QuestionnaireQuestionAnswerPossibility>
              <Answer>sample string 3</Answer>
              <Description>sample string 4</Description>
              <Guid>6bd053c1-d13e-4445-af1a-ee78f206cd8e</Guid>
              <Image>sample string 7</Image>
              <IsActive>true</IsActive>
              <IsDefaultValue>true</IsDefaultValue>
              <NavigationOption>NextQuestion</NavigationOption>
              <NextQuestionGuid>30406688-d00e-4317-8881-80d74d8b75b9</NextQuestionGuid>
              <Rank>2</Rank>
              <SubQuestionGuids xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:guid>c46f6a99-5d17-45ae-aa1d-d00374d6fece</d8p1:guid>
                <d8p1:guid>8b956065-1bc8-4a41-a01e-e8985068fc58</d8p1:guid>
              </SubQuestionGuids>
            </QuestionnaireQuestionAnswerPossibility>
          </AnswerPossibilities>
          <Code>sample string 4</Code>
          <Description>sample string 5</Description>
          <Guid>4613d2a2-1e01-47d5-af8d-5d4e361348f7</Guid>
          <Image>sample string 6</Image>
          <IsSubQuestion>true</IsSubQuestion>
          <Name>sample string 3</Name>
          <NavigationOption>NextQuestion</NavigationOption>
          <NextQuestionGuid>f2e995c8-e1ea-4665-9eab-5d0fda8a7a37</NextQuestionGuid>
          <QuestionCategoryName>sample string 7</QuestionCategoryName>
          <QuestionClientSelection>
            <MaximumClients>1</MaximumClients>
            <MinimumClients>1</MinimumClients>
          </QuestionClientSelection>
          <QuestionCorrelationSelection>
            <MaximumCorrelations>1</MaximumCorrelations>
            <MinimumCorrelations>1</MinimumCorrelations>
          </QuestionCorrelationSelection>
          <QuestionDate>
            <AllowedValueOption>AllDates</AllowedValueOption>
            <CustomDefaultValue>2026-05-26T22:06:54.9478594+02:00</CustomDefaultValue>
            <DefaultValueOption>NotApplicable</DefaultValueOption>
            <IncludeTime>true</IncludeTime>
          </QuestionDate>
          <QuestionEmployeeSelection>
            <MaximumEmployees>1</MaximumEmployees>
            <MinimumEmployees>1</MinimumEmployees>
          </QuestionEmployeeSelection>
          <QuestionNumber>
            <Decimals>1</Decimals>
            <DefaultValue>1</DefaultValue>
            <MaximumValue>1</MaximumValue>
            <MinimumValue>1</MinimumValue>
          </QuestionNumber>
          <QuestionOrganizationEntitySelection>
            <MaximumOrganizationEntities>1</MaximumOrganizationEntities>
            <MinimumOrganizationEntities>1</MinimumOrganizationEntities>
          </QuestionOrganizationEntitySelection>
          <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>
          <Description>sample string 4</Description>
          <Guid>6bd053c1-d13e-4445-af1a-ee78f206cd8e</Guid>
          <Image>sample string 7</Image>
          <IsActive>true</IsActive>
          <IsDefaultValue>true</IsDefaultValue>
          <NavigationOption>NextQuestion</NavigationOption>
          <NextQuestionGuid>30406688-d00e-4317-8881-80d74d8b75b9</NextQuestionGuid>
          <Rank>2</Rank>
          <SubQuestionGuids xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:guid>c46f6a99-5d17-45ae-aa1d-d00374d6fece</d6p1:guid>
            <d6p1:guid>8b956065-1bc8-4a41-a01e-e8985068fc58</d6p1:guid>
          </SubQuestionGuids>
        </QuestionnaireQuestionAnswerPossibility>
        <QuestionnaireQuestionAnswerPossibility>
          <Answer>sample string 3</Answer>
          <Description>sample string 4</Description>
          <Guid>6bd053c1-d13e-4445-af1a-ee78f206cd8e</Guid>
          <Image>sample string 7</Image>
          <IsActive>true</IsActive>
          <IsDefaultValue>true</IsDefaultValue>
          <NavigationOption>NextQuestion</NavigationOption>
          <NextQuestionGuid>30406688-d00e-4317-8881-80d74d8b75b9</NextQuestionGuid>
          <Rank>2</Rank>
          <SubQuestionGuids xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:guid>c46f6a99-5d17-45ae-aa1d-d00374d6fece</d6p1:guid>
            <d6p1:guid>8b956065-1bc8-4a41-a01e-e8985068fc58</d6p1:guid>
          </SubQuestionGuids>
        </QuestionnaireQuestionAnswerPossibility>
      </AnswerPossibilities>
      <Code>sample string 4</Code>
      <Description>sample string 5</Description>
      <Guid>4613d2a2-1e01-47d5-af8d-5d4e361348f7</Guid>
      <Image>sample string 6</Image>
      <IsSubQuestion>true</IsSubQuestion>
      <Name>sample string 3</Name>
      <NavigationOption>NextQuestion</NavigationOption>
      <NextQuestionGuid>f2e995c8-e1ea-4665-9eab-5d0fda8a7a37</NextQuestionGuid>
      <QuestionCategoryName>sample string 7</QuestionCategoryName>
      <QuestionClientSelection>
        <MaximumClients>1</MaximumClients>
        <MinimumClients>1</MinimumClients>
      </QuestionClientSelection>
      <QuestionCorrelationSelection>
        <MaximumCorrelations>1</MaximumCorrelations>
        <MinimumCorrelations>1</MinimumCorrelations>
      </QuestionCorrelationSelection>
      <QuestionDate>
        <AllowedValueOption>AllDates</AllowedValueOption>
        <CustomDefaultValue>2026-05-26T22:06:54.9478594+02:00</CustomDefaultValue>
        <DefaultValueOption>NotApplicable</DefaultValueOption>
        <IncludeTime>true</IncludeTime>
      </QuestionDate>
      <QuestionEmployeeSelection>
        <MaximumEmployees>1</MaximumEmployees>
        <MinimumEmployees>1</MinimumEmployees>
      </QuestionEmployeeSelection>
      <QuestionNumber>
        <Decimals>1</Decimals>
        <DefaultValue>1</DefaultValue>
        <MaximumValue>1</MaximumValue>
        <MinimumValue>1</MinimumValue>
      </QuestionNumber>
      <QuestionOrganizationEntitySelection>
        <MaximumOrganizationEntities>1</MaximumOrganizationEntities>
        <MinimumOrganizationEntities>1</MinimumOrganizationEntities>
      </QuestionOrganizationEntitySelection>
      <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>
          <Description>sample string 4</Description>
          <Guid>6bd053c1-d13e-4445-af1a-ee78f206cd8e</Guid>
          <Image>sample string 7</Image>
          <IsActive>true</IsActive>
          <IsDefaultValue>true</IsDefaultValue>
          <NavigationOption>NextQuestion</NavigationOption>
          <NextQuestionGuid>30406688-d00e-4317-8881-80d74d8b75b9</NextQuestionGuid>
          <Rank>2</Rank>
          <SubQuestionGuids xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:guid>c46f6a99-5d17-45ae-aa1d-d00374d6fece</d6p1:guid>
            <d6p1:guid>8b956065-1bc8-4a41-a01e-e8985068fc58</d6p1:guid>
          </SubQuestionGuids>
        </QuestionnaireQuestionAnswerPossibility>
        <QuestionnaireQuestionAnswerPossibility>
          <Answer>sample string 3</Answer>
          <Description>sample string 4</Description>
          <Guid>6bd053c1-d13e-4445-af1a-ee78f206cd8e</Guid>
          <Image>sample string 7</Image>
          <IsActive>true</IsActive>
          <IsDefaultValue>true</IsDefaultValue>
          <NavigationOption>NextQuestion</NavigationOption>
          <NextQuestionGuid>30406688-d00e-4317-8881-80d74d8b75b9</NextQuestionGuid>
          <Rank>2</Rank>
          <SubQuestionGuids xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:guid>c46f6a99-5d17-45ae-aa1d-d00374d6fece</d6p1:guid>
            <d6p1:guid>8b956065-1bc8-4a41-a01e-e8985068fc58</d6p1:guid>
          </SubQuestionGuids>
        </QuestionnaireQuestionAnswerPossibility>
      </AnswerPossibilities>
      <Code>sample string 4</Code>
      <Description>sample string 5</Description>
      <Guid>4613d2a2-1e01-47d5-af8d-5d4e361348f7</Guid>
      <Image>sample string 6</Image>
      <IsSubQuestion>true</IsSubQuestion>
      <Name>sample string 3</Name>
      <NavigationOption>NextQuestion</NavigationOption>
      <NextQuestionGuid>f2e995c8-e1ea-4665-9eab-5d0fda8a7a37</NextQuestionGuid>
      <QuestionCategoryName>sample string 7</QuestionCategoryName>
      <QuestionClientSelection>
        <MaximumClients>1</MaximumClients>
        <MinimumClients>1</MinimumClients>
      </QuestionClientSelection>
      <QuestionCorrelationSelection>
        <MaximumCorrelations>1</MaximumCorrelations>
        <MinimumCorrelations>1</MinimumCorrelations>
      </QuestionCorrelationSelection>
      <QuestionDate>
        <AllowedValueOption>AllDates</AllowedValueOption>
        <CustomDefaultValue>2026-05-26T22:06:54.9478594+02:00</CustomDefaultValue>
        <DefaultValueOption>NotApplicable</DefaultValueOption>
        <IncludeTime>true</IncludeTime>
      </QuestionDate>
      <QuestionEmployeeSelection>
        <MaximumEmployees>1</MaximumEmployees>
        <MinimumEmployees>1</MinimumEmployees>
      </QuestionEmployeeSelection>
      <QuestionNumber>
        <Decimals>1</Decimals>
        <DefaultValue>1</DefaultValue>
        <MaximumValue>1</MaximumValue>
        <MinimumValue>1</MinimumValue>
      </QuestionNumber>
      <QuestionOrganizationEntitySelection>
        <MaximumOrganizationEntities>1</MaximumOrganizationEntities>
        <MinimumOrganizationEntities>1</MinimumOrganizationEntities>
      </QuestionOrganizationEntitySelection>
      <QuestionText>
        <DefaultValue>sample string 1</DefaultValue>
        <EnableSpellcheck>true</EnableSpellcheck>
        <Format>true</Format>
        <MaximumLength>1</MaximumLength>
      </QuestionText>
      <Rank>2</Rank>
      <Type>MultipleChoice</Type>
    </QuestionnaireQuestion>
  </Questions>
  <ShowQuestionCode>true</ShowQuestionCode>
  <ShowSubQuestionsInPopup>true</ShowSubQuestionsInPopup>
  <ShowTabOverviewAnswers>true</ShowTabOverviewAnswers>
  <ShowTabProperties>true</ShowTabProperties>
  <Version>sample string 4</Version>
</Questionnaire>