POST PlanCare2Api/ClientplansV2/{approvalId}/SetUnApproved

Set an approval to be unapproved.

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

-

IsApproved

The status of the approval.

boolean

-

ApprovalDate

The date of approval.

date

Nullable

ConceptDocumentId

The identifier of the concept approval document.

integer

Nullable

ConceptDocumentName

The filename of the concept approval document.

string

-

SignedDocumentId

The identifier of the signed approval document.

integer

Nullable

SignedDocumentName

The filename of the signed approval 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

-

ClientApproves

The client does approve.

boolean

Nullable

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

ClientSignatoryId

The identifier of the client authorized signatory.

globally unique identifier

Nullable

DurationId

The identifier of the duration of the approval.

integer

Nullable

Duration

The period the approval is valid.

string

-

DurationNumber

The durationnumber the approval is valid.

integer

Nullable

DurationUnit

The unit of the period the approval is valid.

string

-

Response Formats

application/json, text/json

Sample:
{
  "Id": "830fb2dd-ba42-4af9-acbf-b7e0261973eb",
  "Date": "2026-05-26T22:08:06.7614261+02:00",
  "IsApproved": true,
  "ApprovalDate": "2026-05-26T22:08:06.7614261+02:00",
  "ConceptDocumentId": 1,
  "ConceptDocumentName": "sample string 4",
  "SignedDocumentId": 1,
  "SignedDocumentName": "sample string 5",
  "ExpirationDate": "2026-05-26T22:08:06.7614261+02:00",
  "Parts": [
    "sample string 1",
    "sample string 2"
  ],
  "AuthorizedSignatories": [
    {
      "$id": "2",
      "SignerName": "sample string 1",
      "RoleName": "sample string 2",
      "AuthorizedSignerId": 3,
      "HasSigned": true,
      "SigningDate": "2026-05-26T22:08:06.7614261+02:00",
      "Id": "981241f1-c732-4c5c-ba70-d0dda001ec7f",
      "RoleId": "faa11797-1f0d-4106-a484-1c18d2204c0e"
    },
    {
      "$ref": "2"
    }
  ],
  "Remarks": "sample string 6",
  "ClientDisapprovalReason": "sample string 7",
  "ClientApproves": true,
  "ClientHasSigned": true,
  "ClientIsDiscussed": true,
  "ClientSigningDate": "2026-05-26T22:08:06.7614261+02:00",
  "ClientSignatoryId": "505f9b94-2228-483e-9754-ef7ac00a896b",
  "DurationId": 1,
  "Duration": "sample string 8",
  "DurationNumber": 1,
  "DurationUnit": "sample string 9"
}

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-05-26T22:08:06.7614261+02:00</ApprovalDate>
  <AuthorizedSignatories>
    <AuthorizedSignatory>
      <AuthorizedSignerId>3</AuthorizedSignerId>
      <HasSigned>true</HasSigned>
      <Id>981241f1-c732-4c5c-ba70-d0dda001ec7f</Id>
      <RoleId>faa11797-1f0d-4106-a484-1c18d2204c0e</RoleId>
      <SigningDate>2026-05-26T22:08:06.7614261+02:00</SigningDate>
      <RoleName>sample string 2</RoleName>
      <SignerName>sample string 1</SignerName>
    </AuthorizedSignatory>
    <AuthorizedSignatory>
      <AuthorizedSignerId>3</AuthorizedSignerId>
      <HasSigned>true</HasSigned>
      <Id>981241f1-c732-4c5c-ba70-d0dda001ec7f</Id>
      <RoleId>faa11797-1f0d-4106-a484-1c18d2204c0e</RoleId>
      <SigningDate>2026-05-26T22:08:06.7614261+02:00</SigningDate>
      <RoleName>sample string 2</RoleName>
      <SignerName>sample string 1</SignerName>
    </AuthorizedSignatory>
  </AuthorizedSignatories>
  <ClientApproves>true</ClientApproves>
  <ClientDisapprovalReason>sample string 7</ClientDisapprovalReason>
  <ClientHasSigned>true</ClientHasSigned>
  <ClientIsDiscussed>true</ClientIsDiscussed>
  <ClientSignatoryId>505f9b94-2228-483e-9754-ef7ac00a896b</ClientSignatoryId>
  <ClientSigningDate>2026-05-26T22:08:06.7614261+02:00</ClientSigningDate>
  <ConceptDocumentId>1</ConceptDocumentId>
  <ConceptDocumentName>sample string 4</ConceptDocumentName>
  <Date>2026-05-26T22:08:06.7614261+02:00</Date>
  <Duration>sample string 8</Duration>
  <DurationId>1</DurationId>
  <DurationNumber>1</DurationNumber>
  <DurationUnit>sample string 9</DurationUnit>
  <ExpirationDate>2026-05-26T22:08:06.7614261+02:00</ExpirationDate>
  <Id>830fb2dd-ba42-4af9-acbf-b7e0261973eb</Id>
  <IsApproved>true</IsApproved>
  <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>
  <SignedDocumentId>1</SignedDocumentId>
  <SignedDocumentName>sample string 5</SignedDocumentName>
</ClientplanApprovalDetails>