GET PlanCare2Api/Relations/{relationId}/Contacts

Gets all contacts 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 contacts by relation

Collection of Contact

Name	Description	Type	Additional information
Id	The internal id of the contact	integer	None.
RelationId	The internal id of the relation	integer	None.
Type	Contact type	ContactType	None.
Value	Contact value	string	None.
Info	Contact info	string	None.
Rank	Contact rank	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "RelationId": 2,
    "Type": {
      "$id": "2",
      "Id": 1,
      "Description": "sample string 2",
      "IsPrivate": true
    },
    "Value": "sample string 3",
    "Info": "sample string 4",
    "Rank": 5
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Relation">
  <Contact>
    <Id>1</Id>
    <Info>sample string 4</Info>
    <Rank>5</Rank>
    <RelationId>2</RelationId>
    <Type>
      <Description>sample string 2</Description>
      <Id>1</Id>
      <IsPrivate>true</IsPrivate>
    </Type>
    <Value>sample string 3</Value>
  </Contact>
  <Contact>
    <Id>1</Id>
    <Info>sample string 4</Info>
    <Rank>5</Rank>
    <RelationId>2</RelationId>
    <Type>
      <Description>sample string 2</Description>
      <Id>1</Id>
      <IsPrivate>true</IsPrivate>
    </Type>
    <Value>sample string 3</Value>
  </Contact>
</ArrayOfContact>