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 |
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, application/xml, text/xml
Sample:
Sample not available.