GET PlanCare2Api/ClientplansV2/{clientplanId}/basicInformation

Retrieve the basic information of a clientplan V2.

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

Request Information

URI Parameters

Name	Description	Type	Additional information
clientplanId	The clientplan Id.	integer	Required

Body Parameters

None.

Response Information

Resource Description

The basic information of the requested clientplan V2.

BasicInformation

Name	Description	Type	Additional information
ClientplanId	The clientplan id.	integer	None
ResponsiblePersons	The persons responsible for the client.	Collection of ResponsiblePerson	None
LawStatuses	The law statuses	Collection of LawStatus	None
LegalStatuses	The legal statuses	Collection of LegalStatus	None

Response Formats

application/json, text/json

Sample:

{
  "ClientplanId": 1,
  "ResponsiblePersons": [
    {
      "$id": "2",
      "CorrelationId": 1,
      "ClientplanId": 2,
      "RelationId": 3,
      "RelationName": "sample string 4",
      "RoleId": "9a27601b-05f8-4725-9e57-4790bff3066e",
      "RoleName": "sample string 6",
      "StartDate": "2026-05-26T22:01:23.3119349+02:00",
      "EndDate": "2026-05-26T22:01:23.3119349+02:00"
    },
    {
      "$ref": "2"
    }
  ],
  "LawStatuses": [
    {
      "$id": "3",
      "Id": 1,
      "Name": "sample string 2",
      "RelationName": "sample string 3",
      "StartDate": "2026-05-26T22:01:23.3119349+02:00",
      "EndDate": "2026-05-26T22:01:23.3119349+02:00",
      "RelatedRelations": [
        {
          "$id": "4",
          "Id": 1,
          "Name": "sample string 2",
          "RoleName": "sample string 3"
        },
        {
          "$ref": "4"
        }
      ]
    },
    {
      "$ref": "3"
    }
  ],
  "LegalStatuses": [
    {
      "$id": "5",
      "Id": 1,
      "ClientId": {
        "$id": "6",
        "Identifier": "sample string 1",
        "Type": 0
      },
      "Name": "sample string 2",
      "RegistrationDate": "2026-05-26T22:01:23.3119349+02:00",
      "StartDate": "2026-05-26T22:01:23.3119349+02:00",
      "EndDate": "2026-05-26T22:01:23.3119349+02:00"
    },
    {
      "$ref": "5"
    }
  ]
}

application/xml, text/xml

Sample:

<BasicInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <ClientplanId>1</ClientplanId>
  <LawStatuses>
    <LawStatus>
      <EndDate>2026-05-26T22:01:23.3119349+02:00</EndDate>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <RelatedRelations xmlns:d4p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Relation">
        <d4p1:RelationLawStatus>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:RoleName>sample string 3</d4p1:RoleName>
        </d4p1:RelationLawStatus>
        <d4p1:RelationLawStatus>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:RoleName>sample string 3</d4p1:RoleName>
        </d4p1:RelationLawStatus>
      </RelatedRelations>
      <RelationName>sample string 3</RelationName>
      <StartDate>2026-05-26T22:01:23.3119349+02:00</StartDate>
    </LawStatus>
    <LawStatus>
      <EndDate>2026-05-26T22:01:23.3119349+02:00</EndDate>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <RelatedRelations xmlns:d4p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Relation">
        <d4p1:RelationLawStatus>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:RoleName>sample string 3</d4p1:RoleName>
        </d4p1:RelationLawStatus>
        <d4p1:RelationLawStatus>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:RoleName>sample string 3</d4p1:RoleName>
        </d4p1:RelationLawStatus>
      </RelatedRelations>
      <RelationName>sample string 3</RelationName>
      <StartDate>2026-05-26T22:01:23.3119349+02:00</StartDate>
    </LawStatus>
  </LawStatuses>
  <LegalStatuses>
    <LegalStatus>
      <ClientId xmlns:d4p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
        <d4p1:Type>ExternalId</d4p1:Type>
      </ClientId>
      <EndDate>2026-05-26T22:01:23.3119349+02:00</EndDate>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <RegistrationDate>2026-05-26T22:01:23.3119349+02:00</RegistrationDate>
      <StartDate>2026-05-26T22:01:23.3119349+02:00</StartDate>
    </LegalStatus>
    <LegalStatus>
      <ClientId xmlns:d4p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
        <d4p1:Type>ExternalId</d4p1:Type>
      </ClientId>
      <EndDate>2026-05-26T22:01:23.3119349+02:00</EndDate>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <RegistrationDate>2026-05-26T22:01:23.3119349+02:00</RegistrationDate>
      <StartDate>2026-05-26T22:01:23.3119349+02:00</StartDate>
    </LegalStatus>
  </LegalStatuses>
  <ResponsiblePersons>
    <ResponsiblePerson>
      <ClientplanId>2</ClientplanId>
      <CorrelationId>1</CorrelationId>
      <EndDate>2026-05-26T22:01:23.3119349+02:00</EndDate>
      <RelationId>3</RelationId>
      <RelationName>sample string 4</RelationName>
      <RoleId>9a27601b-05f8-4725-9e57-4790bff3066e</RoleId>
      <RoleName>sample string 6</RoleName>
      <StartDate>2026-05-26T22:01:23.3119349+02:00</StartDate>
    </ResponsiblePerson>
    <ResponsiblePerson>
      <ClientplanId>2</ClientplanId>
      <CorrelationId>1</CorrelationId>
      <EndDate>2026-05-26T22:01:23.3119349+02:00</EndDate>
      <RelationId>3</RelationId>
      <RelationName>sample string 4</RelationName>
      <RoleId>9a27601b-05f8-4725-9e57-4790bff3066e</RoleId>
      <RoleName>sample string 6</RoleName>
      <StartDate>2026-05-26T22:01:23.3119349+02:00</StartDate>
    </ResponsiblePerson>
  </ResponsiblePersons>
</BasicInformation>