GET PlanCare2Api/ClientplansV2/{clientplanId}/Responsibles

Retrieve all persons assigned a role as responsible for the clientplan.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientplanId

The clientplan Id.

integer

Required

Body Parameters

None.

Response Information

Resource Description

A list of responsible persons and their role in the clientplan.

Collection of ResponsiblePerson
NameDescriptionTypeAdditional information
CorrelationId

The correlation id.

integer

None

ClientplanId

The clientplan id.

integer

None

RelationId

The relation id.

integer

None

RelationName

The relation name.

string

None

RoleId

The role id.

globally unique identifier

None

RoleName

The role name.

string

None

StartDate

The start date.

date

None

EndDate

The end date.

date

None

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "CorrelationId": 1,
    "ClientplanId": 2,
    "RelationId": 3,
    "RelationName": "sample string 4",
    "RoleId": "d3bc2da8-fe42-4097-ba65-7158778268e8",
    "RoleName": "sample string 6",
    "StartDate": "2026-05-26T21:11:22.4951054+02:00",
    "EndDate": "2026-05-26T21:11:22.4951054+02:00"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfResponsiblePerson xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <ResponsiblePerson>
    <ClientplanId>2</ClientplanId>
    <CorrelationId>1</CorrelationId>
    <EndDate>2026-05-26T21:11:22.4951054+02:00</EndDate>
    <RelationId>3</RelationId>
    <RelationName>sample string 4</RelationName>
    <RoleId>d3bc2da8-fe42-4097-ba65-7158778268e8</RoleId>
    <RoleName>sample string 6</RoleName>
    <StartDate>2026-05-26T21:11:22.4951054+02:00</StartDate>
  </ResponsiblePerson>
  <ResponsiblePerson>
    <ClientplanId>2</ClientplanId>
    <CorrelationId>1</CorrelationId>
    <EndDate>2026-05-26T21:11:22.4951054+02:00</EndDate>
    <RelationId>3</RelationId>
    <RelationName>sample string 4</RelationName>
    <RoleId>d3bc2da8-fe42-4097-ba65-7158778268e8</RoleId>
    <RoleName>sample string 6</RoleName>
    <StartDate>2026-05-26T21:11:22.4951054+02:00</StartDate>
  </ResponsiblePerson>
</ArrayOfResponsiblePerson>