GET PlanCare2Api/Call/AvailableClients?callId={callId}

Gets available clients.

Requires 'Start' permission for function CallOverview {0D159E1F-6728-4243-9A43-996F7DC5AD8A}

Request Information

URI Parameters

Name	Description	Type	Additional information
callId	The id of the call.	integer	Required

Body Parameters

None.

Response Information

Resource Description

List of available clients.

Collection of CallAvailableClient

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

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:10:48.121219+02:00",
    "SecretPlacement": true
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCallAvailableClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Call">
  <CallAvailableClient>
    <DateOfBirth>2026-05-26T21:10:48.121219+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>
  </CallAvailableClient>
  <CallAvailableClient>
    <DateOfBirth>2026-05-26T21:10:48.121219+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>
  </CallAvailableClient>
</ArrayOfCallAvailableClient>