GET PlanCare2Api/Relations/Correlations/ContactPersonsWithClients?referenceDate={referenceDate}&allowAccessClientPortal={allowAccessClientPortal}

Gets correlations between contactpersons and clients.

Requires 'Read' permission for function ContactPersonCorrelationsPersonal {020EECF1-4149-4A5E-A990-64B647DE3172}

Request Information

URI Parameters

Name	Description	Type	Additional information
referenceDate	Reference date.	date	Nullable
allowAccessClientPortal	Indicates whether the contactperson has permission to view the client's data in the client web portal.	boolean	Nullable

Body Parameters

None.

Response Information

Resource Description

Correlations between contactpersons and clients.

Collection of ContactPersonClientCorrelation

Name	Description	Type	Additional information
ContactPersonRelationId	The relation identifier of the contactperson.	integer	-
ClientId	The identifier of the client.	integer	-
ClientRelationId	The relation identifier for the client.	integer	-
AllowAccessClientPortal	Indicates whether the contactperson has permission to view the client's data in the client web portal.	boolean	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "ContactPersonRelationId": 1,
    "ClientId": 2,
    "ClientRelationId": 3,
    "AllowAccessClientPortal": true
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfContactPersonClientCorrelation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Relation">
  <ContactPersonClientCorrelation>
    <AllowAccessClientPortal>true</AllowAccessClientPortal>
    <ClientId>2</ClientId>
    <ClientRelationId>3</ClientRelationId>
    <ContactPersonRelationId>1</ContactPersonRelationId>
  </ContactPersonClientCorrelation>
  <ContactPersonClientCorrelation>
    <AllowAccessClientPortal>true</AllowAccessClientPortal>
    <ClientId>2</ClientId>
    <ClientRelationId>3</ClientRelationId>
    <ContactPersonRelationId>1</ContactPersonRelationId>
  </ContactPersonClientCorrelation>
</ArrayOfContactPersonClientCorrelation>