GET PlanCare2Api/Clients?relationId={relationId}

Gets a client by using the relation identifier

Request Information

URI Parameters

Name	Description	Type	Additional information
relationId	Identifier of relation	integer	Required

Body Parameters

None.

Response Information

Resource Description

Client

Name	Description	Type	Additional information
RelationId	Id of relation	integer	None.
SocialSecurityNumber	SocialSecurityNumber	string	None.
SocialSecurityNumberVerified	SocialSecurityNumberVerified	boolean	None.
SocialSecurityNumberVerificationInfo	SocialSecurityNumberVerificationInfo	string	None.
FirstName	FirstName	string	None.
Initials	Initials	string	None.
NickName	NickName	string	None.
BirthName	BirthName	string	None.
BirthNamePrefix	BirthNamePrefix	string	None.
PartnerName	PartnerName	string	None.
PartnerNamePrefix	PartnerNamePrefix	string	None.
LookupName	LookupName	string	None.
LastName	LastName	string	None.
Gender	Gender	string	None.
DateOfBirth	DateOfBirth	date	None.
CityOfBirth	CityOfBirth	string	None.
CountryOfBirthId	CountryOfBirthId	integer	None.
DateOfDeath	DateOfDeath	date	None.
Remarks	Remarks	string	None.
Photo	Photo	Collection of byte	None.
PhotoMimeType	Mime type of the Photo image	string	None.
MaritalStatus	MaritalStatus	string	None.
LegalStatus	LegalStatus	string	None.
ParticularFormOfCommunication	ParticularFormOfCommunication	string	None.
LivingUnit	LivingUnit	string	None.
NationalityId	NationalityId	integer	None.
Nationality	Nationality	string	None.
LanguageId	LanguageId	integer	None.
Language	Language	string	None.
ReligionId	ReligionId	integer	None.
Religion	Religion	string	None.
ClientId	Contains the id of the client.	integer	None.
MigrationIdentifier	Contains the id of the client which used in PlanCare Dossier, also known as 'BewonerId'.	integer	None.
NameUsage	Rule for formatting the LastName	NameUsage	None.
RegistrationNumber	Registration number	string	None.
SecretPlacement	SecretPlacement	boolean	None.
DebtorNumber	DebtorNumber	string	None.

Response Formats

application/json, text/json

Sample:

{
  "RelationId": 1,
  "SocialSecurityNumber": "sample string 2",
  "SocialSecurityNumberVerified": true,
  "SocialSecurityNumberVerificationInfo": "sample string 4",
  "FirstName": "sample string 5",
  "Initials": "sample string 6",
  "NickName": "sample string 7",
  "BirthName": "sample string 8",
  "BirthNamePrefix": "sample string 9",
  "PartnerName": "sample string 10",
  "PartnerNamePrefix": "sample string 11",
  "LookupName": "sample string 12",
  "LastName": "sample string 13",
  "Gender": "sample string 14",
  "DateOfBirth": "2026-05-26T22:09:02.33266+02:00",
  "CityOfBirth": "sample string 15",
  "CountryOfBirthId": 1,
  "DateOfDeath": "2026-05-26T22:09:02.33266+02:00",
  "Remarks": "sample string 16",
  "Photo": "QEA=",
  "PhotoMimeType": "sample string 17",
  "MaritalStatus": "sample string 18",
  "LegalStatus": "sample string 19",
  "ParticularFormOfCommunication": "sample string 20",
  "LivingUnit": "sample string 21",
  "NationalityId": 1,
  "Nationality": "sample string 22",
  "LanguageId": 1,
  "Language": "sample string 23",
  "ReligionId": 1,
  "Religion": "sample string 24",
  "ClientId": 25,
  "MigrationIdentifier": 1,
  "NameUsage": 0,
  "RegistrationNumber": "sample string 26",
  "SecretPlacement": true,
  "DebtorNumber": "sample string 28"
}

application/xml, text/xml

Sample:

<Client xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Client">
  <BirthName>sample string 8</BirthName>
  <BirthNamePrefix>sample string 9</BirthNamePrefix>
  <CityOfBirth>sample string 15</CityOfBirth>
  <ClientId>25</ClientId>
  <CountryOfBirthId>1</CountryOfBirthId>
  <DateOfBirth>2026-05-26T22:09:02.33266+02:00</DateOfBirth>
  <DateOfDeath>2026-05-26T22:09:02.33266+02:00</DateOfDeath>
  <DebtorNumber>sample string 28</DebtorNumber>
  <FirstName>sample string 5</FirstName>
  <Gender>sample string 14</Gender>
  <Initials>sample string 6</Initials>
  <Language>sample string 23</Language>
  <LanguageId>1</LanguageId>
  <LastName>sample string 13</LastName>
  <LegalStatus>sample string 19</LegalStatus>
  <LivingUnit>sample string 21</LivingUnit>
  <LookupName>sample string 12</LookupName>
  <MaritalStatus>sample string 18</MaritalStatus>
  <MigrationIdentifier>1</MigrationIdentifier>
  <NameUsage>Custom</NameUsage>
  <Nationality>sample string 22</Nationality>
  <NationalityId>1</NationalityId>
  <NickName>sample string 7</NickName>
  <ParticularFormOfCommunication>sample string 20</ParticularFormOfCommunication>
  <PartnerName>sample string 10</PartnerName>
  <PartnerNamePrefix>sample string 11</PartnerNamePrefix>
  <Photo>QEA=</Photo>
  <PhotoMimeType>sample string 17</PhotoMimeType>
  <RegistrationNumber>sample string 26</RegistrationNumber>
  <RelationId>1</RelationId>
  <Religion>sample string 24</Religion>
  <ReligionId>1</ReligionId>
  <Remarks>sample string 16</Remarks>
  <SecretPlacement>true</SecretPlacement>
  <SocialSecurityNumber>sample string 2</SocialSecurityNumber>
  <SocialSecurityNumberVerificationInfo>sample string 4</SocialSecurityNumberVerificationInfo>
  <SocialSecurityNumberVerified>true</SocialSecurityNumberVerified>
</Client>