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	None
Role	Role	string	None
Description	Description	string	None
Priority	Priority	SocialNetworkPriority	None
RelationTypeOut	RelationType out	SocialNetworkRelationType	None
RelationTypeIn	RelationType in	SocialNetworkRelationType	None
Tasks	Tasks	Collection of SocialNetworkTask	None

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": "7e9d3e70-835f-4b37-8461-fb13c44653c0",
      "Rank": 2,
      "Description": "sample string 3",
      "Color": "sample string 4"
    },
    "RelationTypeOut": {
      "$id": "3",
      "Guid": "073278ec-e1b4-4b0d-947c-e0ca2e18b1a8",
      "Rank": 2,
      "Description": "sample string 3",
      "Color": "sample string 4"
    },
    "RelationTypeIn": {
      "$ref": "3"
    },
    "Tasks": [
      {
        "$id": "4",
        "Guid": "5df794c3-5416-4fdd-a5de-b3b62ca54bb9",
        "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>7e9d3e70-835f-4b37-8461-fb13c44653c0</Guid>
      <Rank>2</Rank>
    </Priority>
    <RelationTypeIn>
      <Color>sample string 4</Color>
      <Description>sample string 3</Description>
      <Guid>073278ec-e1b4-4b0d-947c-e0ca2e18b1a8</Guid>
      <Rank>2</Rank>
    </RelationTypeIn>
    <RelationTypeOut>
      <Color>sample string 4</Color>
      <Description>sample string 3</Description>
      <Guid>073278ec-e1b4-4b0d-947c-e0ca2e18b1a8</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>5df794c3-5416-4fdd-a5de-b3b62ca54bb9</Guid>
      </SocialNetworkTask>
      <SocialNetworkTask>
        <Code>sample string 2</Code>
        <Color>sample string 4</Color>
        <Description>sample string 3</Description>
        <Guid>5df794c3-5416-4fdd-a5de-b3b62ca54bb9</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>7e9d3e70-835f-4b37-8461-fb13c44653c0</Guid>
      <Rank>2</Rank>
    </Priority>
    <RelationTypeIn>
      <Color>sample string 4</Color>
      <Description>sample string 3</Description>
      <Guid>073278ec-e1b4-4b0d-947c-e0ca2e18b1a8</Guid>
      <Rank>2</Rank>
    </RelationTypeIn>
    <RelationTypeOut>
      <Color>sample string 4</Color>
      <Description>sample string 3</Description>
      <Guid>073278ec-e1b4-4b0d-947c-e0ca2e18b1a8</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>5df794c3-5416-4fdd-a5de-b3b62ca54bb9</Guid>
      </SocialNetworkTask>
      <SocialNetworkTask>
        <Code>sample string 2</Code>
        <Color>sample string 4</Color>
        <Description>sample string 3</Description>
        <Guid>5df794c3-5416-4fdd-a5de-b3b62ca54bb9</Guid>
      </SocialNetworkTask>
    </Tasks>
  </SocialNetworkRelationSummary>
</ArrayOfSocialNetworkRelationSummary>