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 |
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": "a3db7495-b8cf-402a-92c1-f6dfb6b98b5e",
"Name": "sample string 2",
"Description": "sample string 3",
"Version": "sample string 4",
"QuestionCategories": [
{
"$id": "2",
"Guid": "c157374b-7b0d-44f1-92bb-4d908fde8069",
"Rank": 2,
"Name": "sample string 3",
"StartCollapsed": true,
"Questions": [
{
"$id": "3",
"Guid": "df7183f5-7c8c-4308-9f83-fccafee6a548",
"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": "7eeb6c24-da93-4231-991f-1659df3a9255",
"Rank": 2,
"Answer": "sample string 3",
"IsDefaultValue": true,
"IsActive": true,
"NavigationOption": 0,
"NextQuestionGuid": "04b9fcd9-824f-45e2-96c0-c37d6592b8c9"
},
{
"$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-06-10T12:01:38.950067+02:00",
"AllowedValueOption": 1,
"IncludeTime": true
},
"NavigationOption": 0,
"NextQuestionGuid": "4dd05c73-d658-4d94-86db-0dab4a6c36a6"
},
{
"$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>a3db7495-b8cf-402a-92c1-f6dfb6b98b5e</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>c157374b-7b0d-44f1-92bb-4d908fde8069</Guid>
<Name>sample string 3</Name>
<Questions>
<QuestionnaireQuestion>
<AllowAnswerExplanation>true</AllowAnswerExplanation>
<AnswerIsRequired>true</AnswerIsRequired>
<AnswerPossibilities>
<QuestionnaireQuestionAnswerPossibility>
<Answer>sample string 3</Answer>
<Guid>7eeb6c24-da93-4231-991f-1659df3a9255</Guid>
<IsActive>true</IsActive>
<IsDefaultValue>true</IsDefaultValue>
<NavigationOption>NextQuestion</NavigationOption>
<NextQuestionGuid>04b9fcd9-824f-45e2-96c0-c37d6592b8c9</NextQuestionGuid>
<Rank>2</Rank>
</QuestionnaireQuestionAnswerPossibility>
<QuestionnaireQuestionAnswerPossibility>
<Answer>sample string 3</Answer>
<Guid>7eeb6c24-da93-4231-991f-1659df3a9255</Guid>
<IsActive>true</IsActive>
<IsDefaultValue>true</IsDefaultValue>
<NavigationOption>NextQuestion</NavigationOption>
<NextQuestionGuid>04b9fcd9-824f-45e2-96c0-c37d6592b8c9</NextQuestionGuid>
<Rank>2</Rank>
</QuestionnaireQuestionAnswerPossibility>
</AnswerPossibilities>
<Code>sample string 4</Code>
<Description>sample string 5</Description>
<Guid>df7183f5-7c8c-4308-9f83-fccafee6a548</Guid>
<Name>sample string 3</Name>
<NavigationOption>NextQuestion</NavigationOption>
<NextQuestionGuid>4dd05c73-d658-4d94-86db-0dab4a6c36a6</NextQuestionGuid>
<QuestionCategoryName>sample string 6</QuestionCategoryName>
<QuestionDate>
<AllowedValueOption>AllDates</AllowedValueOption>
<CustomDefaultValue>2026-06-10T12:01:38.950067+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>7eeb6c24-da93-4231-991f-1659df3a9255</Guid>
<IsActive>true</IsActive>
<IsDefaultValue>true</IsDefaultValue>
<NavigationOption>NextQuestion</NavigationOption>
<NextQuestionGuid>04b9fcd9-824f-45e2-96c0-c37d6592b8c9</NextQuestionGuid>
<Rank>2</Rank>
</QuestionnaireQuestionAnswerPossibility>
<QuestionnaireQuestionAnswerPossibility>
<Answer>sample string 3</Answer>
<Guid>7eeb6c24-da93-4231-991f-1659df3a9255</Guid>
<IsActive>true</IsActive>
<IsDefaultValue>true</IsDefaultValue>
<NavigationOption>NextQuestion</NavigationOption>
<NextQuestionGuid>04b9fcd9-824f-45e2-96c0-c37d6592b8c9</NextQuestionGuid>
<Rank>2</Rank>
</QuestionnaireQuestionAnswerPossibility>
</AnswerPossibilities>
<Code>sample string 4</Code>
<Description>sample string 5</Description>
<Guid>df7183f5-7c8c-4308-9f83-fccafee6a548</Guid>
<Name>sample string 3</Name>
<NavigationOption>NextQuestion</NavigationOption>
<NextQuestionGuid>4dd05c73-d658-4d94-86db-0dab4a6c36a6</NextQuestionGuid>
<QuestionCategoryName>sample string 6</QuestionCategoryName>
<QuestionDate>
<AllowedValueOption>AllDates</AllowedValueOption>
<CustomDefaultValue>2026-06-10T12:01:38.950067+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>7eeb6c24-da93-4231-991f-1659df3a9255</Guid>
<IsActive>true</IsActive>
<IsDefaultValue>true</IsDefaultValue>
<NavigationOption>NextQuestion</NavigationOption>
<NextQuestionGuid>04b9fcd9-824f-45e2-96c0-c37d6592b8c9</NextQuestionGuid>
<Rank>2</Rank>
</QuestionnaireQuestionAnswerPossibility>
<QuestionnaireQuestionAnswerPossibility>
<Answer>sample string 3</Answer>
<Guid>7eeb6c24-da93-4231-991f-1659df3a9255</Guid>
<IsActive>true</IsActive>
<IsDefaultValue>true</IsDefaultValue>
<NavigationOption>NextQuestion</NavigationOption>
<NextQuestionGuid>04b9fcd9-824f-45e2-96c0-c37d6592b8c9</NextQuestionGuid>
<Rank>2</Rank>
</QuestionnaireQuestionAnswerPossibility>
</AnswerPossibilities>
<Code>sample string 4</Code>
<Description>sample string 5</Description>
<Guid>df7183f5-7c8c-4308-9f83-fccafee6a548</Guid>
<Name>sample string 3</Name>
<NavigationOption>NextQuestion</NavigationOption>
<NextQuestionGuid>4dd05c73-d658-4d94-86db-0dab4a6c36a6</NextQuestionGuid>
<QuestionCategoryName>sample string 6</QuestionCategoryName>
<QuestionDate>
<AllowedValueOption>AllDates</AllowedValueOption>
<CustomDefaultValue>2026-06-10T12:01:38.950067+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>7eeb6c24-da93-4231-991f-1659df3a9255</Guid>
<IsActive>true</IsActive>
<IsDefaultValue>true</IsDefaultValue>
<NavigationOption>NextQuestion</NavigationOption>
<NextQuestionGuid>04b9fcd9-824f-45e2-96c0-c37d6592b8c9</NextQuestionGuid>
<Rank>2</Rank>
</QuestionnaireQuestionAnswerPossibility>
<QuestionnaireQuestionAnswerPossibility>
<Answer>sample string 3</Answer>
<Guid>7eeb6c24-da93-4231-991f-1659df3a9255</Guid>
<IsActive>true</IsActive>
<IsDefaultValue>true</IsDefaultValue>
<NavigationOption>NextQuestion</NavigationOption>
<NextQuestionGuid>04b9fcd9-824f-45e2-96c0-c37d6592b8c9</NextQuestionGuid>
<Rank>2</Rank>
</QuestionnaireQuestionAnswerPossibility>
</AnswerPossibilities>
<Code>sample string 4</Code>
<Description>sample string 5</Description>
<Guid>df7183f5-7c8c-4308-9f83-fccafee6a548</Guid>
<Name>sample string 3</Name>
<NavigationOption>NextQuestion</NavigationOption>
<NextQuestionGuid>4dd05c73-d658-4d94-86db-0dab4a6c36a6</NextQuestionGuid>
<QuestionCategoryName>sample string 6</QuestionCategoryName>
<QuestionDate>
<AllowedValueOption>AllDates</AllowedValueOption>
<CustomDefaultValue>2026-06-10T12:01:38.950067+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>