GET PlanCare2Api/Relations/{relationId}/Addresses

Gets all the addresses for a relation by relation id

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

Request Information

URI Parameters

Name	Description	Type	Additional information
relationId	relation identifier	integer	Required

Body Parameters

None.

Response Information

Resource Description

The list of Addresses for a relation

Collection of Address

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

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-26T21:01:18.744514+02:00",
    "ValidUntil": "2026-05-26T21:01:18.744514+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-26T21:01:18.744514+02:00</ValidFrom>
    <ValidUntil>2026-05-26T21:01:18.744514+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-26T21:01:18.744514+02:00</ValidFrom>
    <ValidUntil>2026-05-26T21:01:18.744514+02:00</ValidUntil>
  </Address>
</ArrayOfAddress>