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

NameDescriptionTypeAdditional information
relationId

Id of relation.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Organization-correlations.

Collection of RelationCorrelationOrganizationSummary
NameDescriptionTypeAdditional information
CorrelationId

CorrelationId

integer

None

RelationId

RelationId

integer

None

RelationLookUpName

RelationLookUpName

string

None

OrganizationEntityId

OrganizationEntityId

integer

None

OrganizationEntityName

OrganizationEntityName

string

None

Priority

Priority

integer

None

StartDate

Start date

date

None

EndDate

End date

date

None

Description

Description

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.7671103+02:00",
    "EndDate": "2026-05-26T22:08:39.7671103+02:00",
    "Description": "sample string 8"
  },
  {
    "$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>
    <CorrelationId>1</CorrelationId>
    <Description>sample string 8</Description>
    <EndDate>2026-05-26T22:08:39.7671103+02:00</EndDate>
    <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.7671103+02:00</StartDate>
  </RelationCorrelationOrganizationSummary>
  <RelationCorrelationOrganizationSummary>
    <CorrelationId>1</CorrelationId>
    <Description>sample string 8</Description>
    <EndDate>2026-05-26T22:08:39.7671103+02:00</EndDate>
    <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.7671103+02:00</StartDate>
  </RelationCorrelationOrganizationSummary>
</ArrayOfRelationCorrelationOrganizationSummary>