GET PlanCare2Api/ClientplansV2/{approvalId}/Approval

Retrieve the approval of a clientplan V2.

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

Request Information

URI Parameters

Name	Description	Type	Additional information
approvalId	The clientplan approval Identifier.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

The ClientplanApproval instance.

ClientplanApprovalDetails

Name	Description	Type	Additional information
Id	The identifier of the clientplan approval.	globally unique identifier	-
Date	The creation date.	date	-
ApprovalDate	The date of approval.	date	Nullable
DocumentId	The identifier of the approval document or the concept document if the the approval document does not exist.	integer	-
DocumentName	The filename of the approval document.	string	-
ConceptDocumentName	The filename of the concept document.	string	-
ExpirationDate	The calculated date until which the approval is valid.	date	Nullable
Parts	The clientplan parts associated with the approval.	Collection of string	-
AuthorizedSignatories	A list of authorized signatory persons.	Collection of AuthorizedSignatory	-
Remarks	The remarks about the approval.	string	-
ClientDisapprovalReason	The reason why the client does not approve.	string	-
ClientHasSigned	Client has signed the approval.	boolean	Nullable
ClientIsDiscussed	Client has been informed of the approval.	boolean	Nullable
ClientSigningDate	The date on which the client signing took place.	date	Nullable

Response Formats

application/json, text/json

Sample:

{
  "Id": "68b2b6b6-992d-4d19-943e-5c39f84f8e8e",
  "Date": "2026-06-10T12:33:47.2168981+02:00",
  "ApprovalDate": "2026-06-10T12:33:47.2168981+02:00",
  "DocumentId": 3,
  "DocumentName": "sample string 4",
  "ConceptDocumentName": "sample string 5",
  "ExpirationDate": "2026-06-10T12:33:47.2168981+02:00",
  "Parts": [
    "sample string 1",
    "sample string 2"
  ],
  "AuthorizedSignatories": [
    {
      "$id": "2",
      "SignerId": 1,
      "SignerName": "sample string 2",
      "HasSigned": true,
      "SigningDate": "2026-06-10T12:33:47.2168981+02:00"
    },
    {
      "$ref": "2"
    }
  ],
  "Remarks": "sample string 6",
  "ClientDisapprovalReason": "sample string 7",
  "ClientHasSigned": true,
  "ClientIsDiscussed": true,
  "ClientSigningDate": "2026-06-10T12:33:47.2168981+02:00"
}

application/xml, text/xml

Sample:

<ClientplanApprovalDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <ApprovalDate>2026-06-10T12:33:47.2168981+02:00</ApprovalDate>
  <AuthorizedSignatories>
    <AuthorizedSignatory>
      <HasSigned>true</HasSigned>
      <SignerId>1</SignerId>
      <SignerName>sample string 2</SignerName>
      <SigningDate>2026-06-10T12:33:47.2168981+02:00</SigningDate>
    </AuthorizedSignatory>
    <AuthorizedSignatory>
      <HasSigned>true</HasSigned>
      <SignerId>1</SignerId>
      <SignerName>sample string 2</SignerName>
      <SigningDate>2026-06-10T12:33:47.2168981+02:00</SigningDate>
    </AuthorizedSignatory>
  </AuthorizedSignatories>
  <ClientDisapprovalReason>sample string 7</ClientDisapprovalReason>
  <ClientHasSigned>true</ClientHasSigned>
  <ClientIsDiscussed>true</ClientIsDiscussed>
  <ClientSigningDate>2026-06-10T12:33:47.2168981+02:00</ClientSigningDate>
  <ConceptDocumentName>sample string 5</ConceptDocumentName>
  <Date>2026-06-10T12:33:47.2168981+02:00</Date>
  <DocumentId>3</DocumentId>
  <DocumentName>sample string 4</DocumentName>
  <ExpirationDate>2026-06-10T12:33:47.2168981+02:00</ExpirationDate>
  <Id>68b2b6b6-992d-4d19-943e-5c39f84f8e8e</Id>
  <Parts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Parts>
  <Remarks>sample string 6</Remarks>
</ClientplanApprovalDetails>