POST PlanCare2Api/ClientplansV2/{clientplanId}/Approvals

Create a new concept clientplan approval.

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

Request Information

URI Parameters

Name Description Type Additional information
clientplanId

string

-

Body Parameters

The approval to save for the clientplan.

CreateClientplanApproval
Name Description Type Additional information
ClientplanId

The identifier for the clientplan associated with the approval.

integer

-

Date

The creation date.

date

Required

GoalIds

List of identifiers for the goals in the approval.

Collection of integer

-

AgreementIds

List of identifiers for the clientplan agreements in the approval.

Collection of integer

-

ArrangementProductActIds

List of identifiers for the product arrangement product acts in the approval.

Collection of integer

-

InvoluntaryCareIds

List of identifiers for the involuntary cares in the approval (guid).

Collection of globally unique identifier

-

AuthorizedSignatories

List of identifiers for the authorized signatories and the identifiers of their role in the approval.

Collection of ClientplanApprovalAuthorizedSignatorySimple

-

QuestionnaireIds

List of identifiers for the filled questionnaires in the approval.

Collection of integer

-

OmahaInterventionIds

List of identifiers for the Omaha interventions in the approval.

Collection of globally unique identifier

-

ReportOnLocationGuid

The identifier for the specific report on the approval report location that will be used to create the concept approval document. When omitted, the first valid standard report on the approval report location will be used.

globally unique identifier

-

Request Formats

application/json, text/json

Sample:
{
  "ClientplanId": 1,
  "Date": "2026-05-26T22:07:23.4282023+02:00",
  "GoalIds": [
    1,
    2
  ],
  "AgreementIds": [
    1,
    2
  ],
  "ArrangementProductActIds": [
    1,
    2
  ],
  "InvoluntaryCareIds": [
    "bba63ee9-af8a-4fea-bfd2-6e13e45f57d3",
    "bc86d62e-cdf1-4575-8749-279b583d9085"
  ],
  "AuthorizedSignatories": [
    {
      "$id": "2",
      "Id": 1,
      "RoleId": "2d3c7313-ac63-4a72-824a-9aad9fa07b38"
    },
    {
      "$ref": "2"
    }
  ],
  "QuestionnaireIds": [
    1,
    2
  ],
  "OmahaInterventionIds": [
    "3ee24b1b-b58b-436f-9ccb-115e1a9a22f5",
    "ed992030-f330-48c9-8322-74404c95acfd"
  ],
  "ReportOnLocationGuid": "479184f4-3553-4650-a061-02fed468c945"
}

application/xml, text/xml

Sample:
<CreateClientplanApproval xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <AgreementIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </AgreementIds>
  <ArrangementProductActIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </ArrangementProductActIds>
  <AuthorizedSignatories>
    <ClientplanApprovalAuthorizedSignatorySimple>
      <Id>1</Id>
      <RoleId>2d3c7313-ac63-4a72-824a-9aad9fa07b38</RoleId>
    </ClientplanApprovalAuthorizedSignatorySimple>
    <ClientplanApprovalAuthorizedSignatorySimple>
      <Id>1</Id>
      <RoleId>2d3c7313-ac63-4a72-824a-9aad9fa07b38</RoleId>
    </ClientplanApprovalAuthorizedSignatorySimple>
  </AuthorizedSignatories>
  <ClientplanId>1</ClientplanId>
  <Date>2026-05-26T22:07:23.4282023+02:00</Date>
  <GoalIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </GoalIds>
  <InvoluntaryCareIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>bba63ee9-af8a-4fea-bfd2-6e13e45f57d3</d2p1:guid>
    <d2p1:guid>bc86d62e-cdf1-4575-8749-279b583d9085</d2p1:guid>
  </InvoluntaryCareIds>
  <OmahaInterventionIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>3ee24b1b-b58b-436f-9ccb-115e1a9a22f5</d2p1:guid>
    <d2p1:guid>ed992030-f330-48c9-8322-74404c95acfd</d2p1:guid>
  </OmahaInterventionIds>
  <QuestionnaireIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </QuestionnaireIds>
  <ReportOnLocationGuid>479184f4-3553-4650-a061-02fed468c945</ReportOnLocationGuid>
</CreateClientplanApproval>

Response Information

Resource Description

Returns the HttpResponseMessage which contains the saved approval.

HttpResponseMessage
Name Description Type Additional information
Version

Version

-

Content

HttpContent

-

StatusCode

HttpStatusCode

-

ReasonPhrase

string

-

Headers

Collection of Object

-

RequestMessage

HttpRequestMessage

-

IsSuccessStatusCode

boolean

-