GET PlanCare2Api/ClientReports/MeasureClientReports/RelationNotifiers?clientId={clientId}&careResponsiblePersonOnly={careResponsiblePersonOnly}

Get possible relations for notifications about unplanned/incidental measure reports.

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	The identifier of the client to fetch relations for.	integer	Required
careResponsiblePersonOnly	When set to true the careresponsible person will be returned, given an active correlation exists and the requesting employee is not the careresponsible person. When set to false all allowed relations including the careresponsible person will be returned.	boolean	Required

Body Parameters

None.

Response Information

Resource Description

A list of all relations when careResponsiblePersonOnly is false including the careresponsible person when found.

Collection of RelationNotifyInfo

Name	Description	Type	Additional information
RelationId	Id of the relation to be notified.	integer	-
LookupName	Lookupname of the relation to be notified.	string	-
IsCareResponsible	This relation is the careresponsible person.	boolean	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "RelationId": 1,
    "LookupName": "sample string 2",
    "IsCareResponsible": true
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfRelationNotifyInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Relation">
  <RelationNotifyInfo>
    <IsCareResponsible>true</IsCareResponsible>
    <LookupName>sample string 2</LookupName>
    <RelationId>1</RelationId>
  </RelationNotifyInfo>
  <RelationNotifyInfo>
    <IsCareResponsible>true</IsCareResponsible>
    <LookupName>sample string 2</LookupName>
    <RelationId>1</RelationId>
  </RelationNotifyInfo>
</ArrayOfRelationNotifyInfo>