GET PlanCare2Api/Relations/{relationId}/Addresses

Gets addresses by relation.

Relation(s) can be of the following types: Client, Prospect, Family, Employee, ContactPerson, CareProvider

Request Information

URI Parameters

Name	Description	Type	Additional information
relationId	Id of relation.	integer	Required

Body Parameters

None.

Response Information

Resource Description

Addresses.

Collection of Address

Name	Description	Type	Additional information
TypeId	The id of the address type	integer	-
TypeName	The address type as text	string	-
TypeRank	The rank of an address within a address type	integer	-
Street	The street	string	-
HouseNumber	The housenumber	string	-
HouseNumberAddon	The housenumber addon	string	-
HouseNumberAddition	The housenumber addition	string	-
HouseNumberDesignation	The housenumber designation	string	-
City	The city	string	-
Municipality	The municipality	string	-
PostalCode	The postalcode	string	-
CountryId	The id of the country	integer	-
CountryName	The country as text	string	-
ValidFrom	The date when the address is valid	date	Nullable
ValidUntil	The date until which the address is valid	date	Nullable

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "TypeId": 1,
    "TypeName": "sample string 2",
    "TypeRank": 3,
    "Street": "sample string 4",
    "HouseNumber": "sample string 5",
    "HouseNumberAddon": "sample string 6",
    "HouseNumberAddition": "sample string 7",
    "HouseNumberDesignation": "sample string 8",
    "City": "sample string 9",
    "Municipality": "sample string 10",
    "PostalCode": "sample string 11",
    "CountryId": 12,
    "CountryName": "sample string 13",
    "ValidFrom": "2026-05-26T23:20:34.8550991+02:00",
    "ValidUntil": "2026-05-26T23:20:34.8550991+02:00"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Relation">
  <Address>
    <City>sample string 9</City>
    <CountryId>12</CountryId>
    <CountryName>sample string 13</CountryName>
    <HouseNumber>sample string 5</HouseNumber>
    <HouseNumberAddition>sample string 7</HouseNumberAddition>
    <HouseNumberAddon>sample string 6</HouseNumberAddon>
    <HouseNumberDesignation>sample string 8</HouseNumberDesignation>
    <Municipality>sample string 10</Municipality>
    <PostalCode>sample string 11</PostalCode>
    <Street>sample string 4</Street>
    <TypeId>1</TypeId>
    <TypeName>sample string 2</TypeName>
    <TypeRank>3</TypeRank>
    <ValidFrom>2026-05-26T23:20:34.8550991+02:00</ValidFrom>
    <ValidUntil>2026-05-26T23:20:34.8550991+02:00</ValidUntil>
  </Address>
  <Address>
    <City>sample string 9</City>
    <CountryId>12</CountryId>
    <CountryName>sample string 13</CountryName>
    <HouseNumber>sample string 5</HouseNumber>
    <HouseNumberAddition>sample string 7</HouseNumberAddition>
    <HouseNumberAddon>sample string 6</HouseNumberAddon>
    <HouseNumberDesignation>sample string 8</HouseNumberDesignation>
    <Municipality>sample string 10</Municipality>
    <PostalCode>sample string 11</PostalCode>
    <Street>sample string 4</Street>
    <TypeId>1</TypeId>
    <TypeName>sample string 2</TypeName>
    <TypeRank>3</TypeRank>
    <ValidFrom>2026-05-26T23:20:34.8550991+02:00</ValidFrom>
    <ValidUntil>2026-05-26T23:20:34.8550991+02:00</ValidUntil>
  </Address>
</ArrayOfAddress>