GET PlanCare2Api/Questionnaires/Question/AvailableClients?questionGuid={questionGuid}&answerId={answerId}

Gets clients available for question.

Request Information

URI Parameters

Name	Description	Type	Additional information
questionGuid	The id of question.	globally unique identifier	Required
answerId	The id of answer, if given then the selected clients that aren't provided are added to the result.	integer	None

Body Parameters

None.

Response Information

Resource Description

List of clients.

Collection of QuestionnaireQuestionAvailableClient

Name	Description	Type	Additional information
RelationId	RelationId	integer	None
LookupName	LookupName	string	None
FirstName	FirstName	string	None
LastName	LastName	string	None
Prefix	Prefix	string	None
NickName	LastName	string	None
Gender	Gender	string	None
DateOfBirth	DateOfBirth	date	None
SecretPlacement	SecretPlacement	boolean	None

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "RelationId": 1,
    "LookupName": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "Prefix": "sample string 5",
    "NickName": "sample string 6",
    "Gender": "sample string 7",
    "DateOfBirth": "2026-05-26T21:09:14.1156069+02:00",
    "SecretPlacement": true
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfQuestionnaireQuestionAvailableClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Questionnaire">
  <QuestionnaireQuestionAvailableClient>
    <DateOfBirth>2026-05-26T21:09:14.1156069+02:00</DateOfBirth>
    <FirstName>sample string 3</FirstName>
    <Gender>sample string 7</Gender>
    <LastName>sample string 4</LastName>
    <LookupName>sample string 2</LookupName>
    <NickName>sample string 6</NickName>
    <Prefix>sample string 5</Prefix>
    <RelationId>1</RelationId>
    <SecretPlacement>true</SecretPlacement>
  </QuestionnaireQuestionAvailableClient>
  <QuestionnaireQuestionAvailableClient>
    <DateOfBirth>2026-05-26T21:09:14.1156069+02:00</DateOfBirth>
    <FirstName>sample string 3</FirstName>
    <Gender>sample string 7</Gender>
    <LastName>sample string 4</LastName>
    <LookupName>sample string 2</LookupName>
    <NickName>sample string 6</NickName>
    <Prefix>sample string 5</Prefix>
    <RelationId>1</RelationId>
    <SecretPlacement>true</SecretPlacement>
  </QuestionnaireQuestionAvailableClient>
</ArrayOfQuestionnaireQuestionAvailableClient>