GET PlanCare2Api/Relations/{relationId}/Correlations/Organization

Get organization-correlations by relation.

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

Request Information

URI Parameters

Name	Description	Type	Additional information
relationId	Id of relation.	integer	Required

Body Parameters

None.

Response Information

Resource Description

Organization-correlations.

Collection of RelationCorrelationOrganizationSummary

Name	Description	Type	Additional information
CorrelationId	Id of the correlation.	integer	None
RelationId	RelationId of the correlation source.	integer	None
RelationLookUpName	LookUpName of the correlation source.	string	None
OrganizationEntityId	OrganizationEntityId of the organization entity target.	integer	None
OrganizationEntityName	OrganizationEntityName of the organization entity target.	string	None
Priority	Priority of the correlation.	integer	None
StartDate	Start date of the correlation.	date	None
EndDate	End date of the correlation.	date	None
Description	Description of the correlation.	string	None
CostHeading	CostHeading of the target organization entity target.	string	None
Code	Code of the target organization entity target.	string	None
IsStay	Indicates wheter the correlation has any stays.	boolean	None
ExternalId	The external Id of the organization entity target connector, based on the used API key.	string	None

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "CorrelationId": 1,
    "RelationId": 2,
    "RelationLookUpName": "sample string 3",
    "OrganizationEntityId": 4,
    "OrganizationEntityName": "sample string 5",
    "Priority": 6,
    "StartDate": "2026-05-26T22:08:39.1584698+02:00",
    "EndDate": "2026-05-26T22:08:39.1584698+02:00",
    "Description": "sample string 8",
    "CostHeading": "sample string 9",
    "Code": "sample string 10",
    "IsStay": true,
    "ExternalId": "sample string 12"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfRelationCorrelationOrganizationSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Relation">
  <RelationCorrelationOrganizationSummary>
    <Code>sample string 10</Code>
    <CorrelationId>1</CorrelationId>
    <CostHeading>sample string 9</CostHeading>
    <Description>sample string 8</Description>
    <EndDate>2026-05-26T22:08:39.1584698+02:00</EndDate>
    <ExternalId>sample string 12</ExternalId>
    <IsStay>true</IsStay>
    <OrganizationEntityId>4</OrganizationEntityId>
    <OrganizationEntityName>sample string 5</OrganizationEntityName>
    <Priority>6</Priority>
    <RelationId>2</RelationId>
    <RelationLookUpName>sample string 3</RelationLookUpName>
    <StartDate>2026-05-26T22:08:39.1584698+02:00</StartDate>
  </RelationCorrelationOrganizationSummary>
  <RelationCorrelationOrganizationSummary>
    <Code>sample string 10</Code>
    <CorrelationId>1</CorrelationId>
    <CostHeading>sample string 9</CostHeading>
    <Description>sample string 8</Description>
    <EndDate>2026-05-26T22:08:39.1584698+02:00</EndDate>
    <ExternalId>sample string 12</ExternalId>
    <IsStay>true</IsStay>
    <OrganizationEntityId>4</OrganizationEntityId>
    <OrganizationEntityName>sample string 5</OrganizationEntityName>
    <Priority>6</Priority>
    <RelationId>2</RelationId>
    <RelationLookUpName>sample string 3</RelationLookUpName>
    <StartDate>2026-05-26T22:08:39.1584698+02:00</StartDate>
  </RelationCorrelationOrganizationSummary>
</ArrayOfRelationCorrelationOrganizationSummary>