GET PlanCare2Api/ClientplansV2/{clientplanId}/questionnaires

Retrieve the questionnaires of a clientplan V2.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientplanId

The clientplan Id.

integer

Required

Body Parameters

None.

Response Information

Resource Description

The questionnaires of the requested clientplan V2.

Collection of ClientplanQuestionnaire
NameDescriptionTypeAdditional information
Id

The id of the questionnaire.

globally unique identifier

None.

Name

The name of the questionnaire.

string

None.

Version

The version of the questionnaire.

string

None.

FilledQuestionnaires

The filled questionnaires.

Collection of ClientplanFilledQuestionnaire

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Id": "fbd1c0cf-31b9-44c3-9f83-ea97f2fd0a5a",
    "Name": "sample string 2",
    "Version": "sample string 3",
    "FilledQuestionnaires": [
      {
        "$id": "2",
        "Id": 1,
        "Name": "sample string 2",
        "CreationDate": "2026-05-26T22:09:09.528568+02:00",
        "DeterminedOn": "2026-05-26T22:09:09.528568+02:00",
        "Status": "sample string 4"
      },
      {
        "$ref": "2"
      }
    ]
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfClientplanQuestionnaire xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <ClientplanQuestionnaire>
    <FilledQuestionnaires>
      <ClientplanFilledQuestionnaire>
        <CreationDate>2026-05-26T22:09:09.528568+02:00</CreationDate>
        <DeterminedOn>2026-05-26T22:09:09.528568+02:00</DeterminedOn>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <Status>sample string 4</Status>
      </ClientplanFilledQuestionnaire>
      <ClientplanFilledQuestionnaire>
        <CreationDate>2026-05-26T22:09:09.528568+02:00</CreationDate>
        <DeterminedOn>2026-05-26T22:09:09.528568+02:00</DeterminedOn>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <Status>sample string 4</Status>
      </ClientplanFilledQuestionnaire>
    </FilledQuestionnaires>
    <Id>fbd1c0cf-31b9-44c3-9f83-ea97f2fd0a5a</Id>
    <Name>sample string 2</Name>
    <Version>sample string 3</Version>
  </ClientplanQuestionnaire>
  <ClientplanQuestionnaire>
    <FilledQuestionnaires>
      <ClientplanFilledQuestionnaire>
        <CreationDate>2026-05-26T22:09:09.528568+02:00</CreationDate>
        <DeterminedOn>2026-05-26T22:09:09.528568+02:00</DeterminedOn>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <Status>sample string 4</Status>
      </ClientplanFilledQuestionnaire>
      <ClientplanFilledQuestionnaire>
        <CreationDate>2026-05-26T22:09:09.528568+02:00</CreationDate>
        <DeterminedOn>2026-05-26T22:09:09.528568+02:00</DeterminedOn>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <Status>sample string 4</Status>
      </ClientplanFilledQuestionnaire>
    </FilledQuestionnaires>
    <Id>fbd1c0cf-31b9-44c3-9f83-ea97f2fd0a5a</Id>
    <Name>sample string 2</Name>
    <Version>sample string 3</Version>
  </ClientplanQuestionnaire>
</ArrayOfClientplanQuestionnaire>