GET PlanCare2Api/Questionnaires/FilledQuestionnaires?clientId={clientId}&questionnaireGuid={questionnaireGuid}&filledQuestionnairesStatus={filledQuestionnairesStatus}

Gets filled questionnaires for client

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

The id of the client.

integer

Required

questionnaireGuid

The id of the questionnaire.

globally unique identifier

None

filledQuestionnairesStatus

The status of the filled questionnaire.

string

None

Body Parameters

None.

Response Information

Resource Description

Filled questionnaires for which the user has read permission.

Collection of FilledQuestionnaire
NameDescriptionTypeAdditional information
Id

Id.

integer

None

RelationId

Id of the relation.

integer

None

RelationLookUpName

LookUpName of the relation.

string

None

ClientId

Id of the client.

integer

Deprecated (unavailable from 21.01.1P): Please use 'RelationId' instead.

Status

Status.

FilledQuestionnaireStatus

None

StatusDescription

Description of the status.

string

None

QuestionnaireGuid

Guid of the questionnaire.

globally unique identifier

None

QuestionnaireName

Name of the questionnaire.

string

None

QuestionnaireVersion

Version of the questionnaire.

string

None

CreatedBy

CreatedBy.

string

None

CreatedOn

CreatedOn.

date

None

LastChangedBy

LastChangedBy.

string

None

LastChangedOn

LastChangedOn.

date

None

Locked

Locked.

boolean

None

LockedByLoggedOnAccessUser

LockedByLoggedOnAccessUser.

boolean

None

LockedBy

LockedBy.

string

None

LockedOn

LockedOn.

date

None

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Id": 1,
    "RelationId": 2,
    "RelationLookUpName": "sample string 3",
    "ClientId": 4,
    "Status": 1,
    "StatusDescription": "sample string 5",
    "QuestionnaireGuid": "116e547d-f466-4c32-b825-68f467c43069",
    "QuestionnaireName": "sample string 7",
    "QuestionnaireVersion": "sample string 8",
    "CreatedBy": "sample string 9",
    "CreatedOn": "2026-05-26T21:09:18.2225558+02:00",
    "LastChangedBy": "sample string 11",
    "LastChangedOn": "2026-05-26T21:09:18.2225558+02:00",
    "Locked": true,
    "LockedByLoggedOnAccessUser": true,
    "LockedBy": "sample string 14",
    "LockedOn": "2026-05-26T21:09:18.2225558+02:00"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfFilledQuestionnaire xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Questionnaire">
  <FilledQuestionnaire>
    <ClientId>4</ClientId>
    <CreatedBy>sample string 9</CreatedBy>
    <CreatedOn>2026-05-26T21:09:18.2225558+02:00</CreatedOn>
    <Id>1</Id>
    <LastChangedBy>sample string 11</LastChangedBy>
    <LastChangedOn>2026-05-26T21:09:18.2225558+02:00</LastChangedOn>
    <Locked>true</Locked>
    <LockedBy>sample string 14</LockedBy>
    <LockedByLoggedOnAccessUser>true</LockedByLoggedOnAccessUser>
    <LockedOn>2026-05-26T21:09:18.2225558+02:00</LockedOn>
    <QuestionnaireGuid>116e547d-f466-4c32-b825-68f467c43069</QuestionnaireGuid>
    <QuestionnaireName>sample string 7</QuestionnaireName>
    <QuestionnaireVersion>sample string 8</QuestionnaireVersion>
    <RelationId>2</RelationId>
    <RelationLookUpName>sample string 3</RelationLookUpName>
    <Status>Concept</Status>
    <StatusDescription>sample string 5</StatusDescription>
  </FilledQuestionnaire>
  <FilledQuestionnaire>
    <ClientId>4</ClientId>
    <CreatedBy>sample string 9</CreatedBy>
    <CreatedOn>2026-05-26T21:09:18.2225558+02:00</CreatedOn>
    <Id>1</Id>
    <LastChangedBy>sample string 11</LastChangedBy>
    <LastChangedOn>2026-05-26T21:09:18.2225558+02:00</LastChangedOn>
    <Locked>true</Locked>
    <LockedBy>sample string 14</LockedBy>
    <LockedByLoggedOnAccessUser>true</LockedByLoggedOnAccessUser>
    <LockedOn>2026-05-26T21:09:18.2225558+02:00</LockedOn>
    <QuestionnaireGuid>116e547d-f466-4c32-b825-68f467c43069</QuestionnaireGuid>
    <QuestionnaireName>sample string 7</QuestionnaireName>
    <QuestionnaireVersion>sample string 8</QuestionnaireVersion>
    <RelationId>2</RelationId>
    <RelationLookUpName>sample string 3</RelationLookUpName>
    <Status>Concept</Status>
    <StatusDescription>sample string 5</StatusDescription>
  </FilledQuestionnaire>
</ArrayOfFilledQuestionnaire>