GET PlanCare2Api/SocialNetwork/{relationId}/Relations

Gets the social network relation summaries of a relation.

Relation(s) must be of the following type: Client

Requires 'Start' permission for function ClientSocialNetwork {AF5A3543-0BF7-49CE-9023-4FF605C225A4}

Request Information

URI Parameters

Name	Description	Type	Additional information
relationId	The id of the relation.	integer	Required

Body Parameters

None.

Response Information

Resource Description

Social network

Collection of SocialNetworkRelationSummary

Name	Description	Type	Additional information
Name	Name	string	-
Role	Role	string	-
Description	Description	string	-
Priority	Priority	SocialNetworkPriority	-
RelationTypeOut	RelationType out	SocialNetworkRelationType	-
RelationTypeIn	RelationType in	SocialNetworkRelationType	-
Tasks	Tasks	Collection of SocialNetworkTask	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Name": "sample string 1",
    "Role": "sample string 2",
    "Description": "sample string 3",
    "Priority": {
      "$id": "2",
      "Guid": "f8dd12ed-4368-49db-bf9b-927da1d02627",
      "Rank": 2,
      "Description": "sample string 3",
      "Color": "sample string 4"
    },
    "RelationTypeOut": {
      "$id": "3",
      "Guid": "51a6503c-2242-4725-96fc-9fa26462600d",
      "Rank": 2,
      "Description": "sample string 3",
      "Color": "sample string 4"
    },
    "RelationTypeIn": {
      "$ref": "3"
    },
    "Tasks": [
      {
        "$id": "4",
        "Guid": "55aec9e3-1865-4775-bbf4-c2bad4130f2f",
        "Code": "sample string 2",
        "Description": "sample string 3",
        "Color": "sample string 4"
      },
      {
        "$ref": "4"
      }
    ]
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSocialNetworkRelationSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
  <SocialNetworkRelationSummary>
    <Description>sample string 3</Description>
    <Name>sample string 1</Name>
    <Priority>
      <Color>sample string 4</Color>
      <Description>sample string 3</Description>
      <Guid>f8dd12ed-4368-49db-bf9b-927da1d02627</Guid>
      <Rank>2</Rank>
    </Priority>
    <RelationTypeIn>
      <Color>sample string 4</Color>
      <Description>sample string 3</Description>
      <Guid>51a6503c-2242-4725-96fc-9fa26462600d</Guid>
      <Rank>2</Rank>
    </RelationTypeIn>
    <RelationTypeOut>
      <Color>sample string 4</Color>
      <Description>sample string 3</Description>
      <Guid>51a6503c-2242-4725-96fc-9fa26462600d</Guid>
      <Rank>2</Rank>
    </RelationTypeOut>
    <Role>sample string 2</Role>
    <Tasks>
      <SocialNetworkTask>
        <Code>sample string 2</Code>
        <Color>sample string 4</Color>
        <Description>sample string 3</Description>
        <Guid>55aec9e3-1865-4775-bbf4-c2bad4130f2f</Guid>
      </SocialNetworkTask>
      <SocialNetworkTask>
        <Code>sample string 2</Code>
        <Color>sample string 4</Color>
        <Description>sample string 3</Description>
        <Guid>55aec9e3-1865-4775-bbf4-c2bad4130f2f</Guid>
      </SocialNetworkTask>
    </Tasks>
  </SocialNetworkRelationSummary>
  <SocialNetworkRelationSummary>
    <Description>sample string 3</Description>
    <Name>sample string 1</Name>
    <Priority>
      <Color>sample string 4</Color>
      <Description>sample string 3</Description>
      <Guid>f8dd12ed-4368-49db-bf9b-927da1d02627</Guid>
      <Rank>2</Rank>
    </Priority>
    <RelationTypeIn>
      <Color>sample string 4</Color>
      <Description>sample string 3</Description>
      <Guid>51a6503c-2242-4725-96fc-9fa26462600d</Guid>
      <Rank>2</Rank>
    </RelationTypeIn>
    <RelationTypeOut>
      <Color>sample string 4</Color>
      <Description>sample string 3</Description>
      <Guid>51a6503c-2242-4725-96fc-9fa26462600d</Guid>
      <Rank>2</Rank>
    </RelationTypeOut>
    <Role>sample string 2</Role>
    <Tasks>
      <SocialNetworkTask>
        <Code>sample string 2</Code>
        <Color>sample string 4</Color>
        <Description>sample string 3</Description>
        <Guid>55aec9e3-1865-4775-bbf4-c2bad4130f2f</Guid>
      </SocialNetworkTask>
      <SocialNetworkTask>
        <Code>sample string 2</Code>
        <Color>sample string 4</Color>
        <Description>sample string 3</Description>
        <Guid>55aec9e3-1865-4775-bbf4-c2bad4130f2f</Guid>
      </SocialNetworkTask>
    </Tasks>
  </SocialNetworkRelationSummary>
</ArrayOfSocialNetworkRelationSummary>