GET PlanCare2Api/Clients/{relationId}/PersonalData

Gets the personal data for a client

Request Information

URI Parameters

NameDescriptionTypeAdditional information
relationId

The relationId of the client

integer

Required

Body Parameters

None.

Response Information

Resource Description

ClientPersonalData

ClientPersonalData
NameDescriptionTypeAdditional information
RelationId

The internal RelationId

integer

None

FirstNames

Firstnames

string

None

Initials

Initials

string

None

Nickname

Nickname

string

None

BirthName

Birthname

string

None

BirthNamePrefix

Birthname prefix

string

None

PartnerName

Partnername

string

None

PartnerNamePrefix

Partnername prefix

string

None

RelationLastNameFormatId

The id of the RelationLastNameFormat that indicates how the lastname is generated

integer

None

Lastname

The lastname. This name is generated based on the RelationLastNameFormatId.

string

None

RelationLookupNameFormatId

The id of the RelationLookupNameFormat that indicates how the lookupname is generated

integer

None

LookupName

The lookupname. This name is generated based on the RelationLookupNameFormatId

string

None

RelationGenderId

The id of the RelationGender indicating the gender

integer

None

DateOfBirth

The date of birth

date

None

CityOfBirth

The city of birth

string

None

RelationCountryOfBirthId

The id of the RelationCountry indicating the country of birth

integer

None

DateOfDeath

The date of deceased

date

None

Remarks

Remarks

string

None

Response Formats

application/json, text/json

Sample:
{
  "RelationId": 1,
  "FirstNames": "sample string 2",
  "Initials": "sample string 3",
  "Nickname": "sample string 4",
  "BirthName": "sample string 5",
  "BirthNamePrefix": "sample string 6",
  "PartnerName": "sample string 7",
  "PartnerNamePrefix": "sample string 8",
  "RelationLastNameFormatId": 1,
  "Lastname": "sample string 9",
  "RelationLookupNameFormatId": 10,
  "LookupName": "sample string 11",
  "RelationGenderId": 12,
  "DateOfBirth": "2026-05-26T22:07:34.6572047+02:00",
  "CityOfBirth": "sample string 13",
  "RelationCountryOfBirthId": 1,
  "DateOfDeath": "2026-05-26T22:07:34.6572047+02:00",
  "Remarks": "sample string 14"
}

application/xml, text/xml

Sample:
<ClientPersonalData 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 5</BirthName>
  <BirthNamePrefix>sample string 6</BirthNamePrefix>
  <CityOfBirth>sample string 13</CityOfBirth>
  <DateOfBirth>2026-05-26T22:07:34.6572047+02:00</DateOfBirth>
  <DateOfDeath>2026-05-26T22:07:34.6572047+02:00</DateOfDeath>
  <FirstNames>sample string 2</FirstNames>
  <Initials>sample string 3</Initials>
  <Lastname>sample string 9</Lastname>
  <LookupName>sample string 11</LookupName>
  <Nickname>sample string 4</Nickname>
  <PartnerName>sample string 7</PartnerName>
  <PartnerNamePrefix>sample string 8</PartnerNamePrefix>
  <RelationCountryOfBirthId>1</RelationCountryOfBirthId>
  <RelationGenderId>12</RelationGenderId>
  <RelationId>1</RelationId>
  <RelationLastNameFormatId>1</RelationLastNameFormatId>
  <RelationLookupNameFormatId>10</RelationLookupNameFormatId>
  <Remarks>sample string 14</Remarks>
</ClientPersonalData>