POST PlanCare2Api/ClientReports/GoalClientReports

Saves a new GoalClientReport instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

Request Information

URI Parameters

None.

Body Parameters

The clientReport instance based on an goal that is being created

Name	Description	Type	Additional information
GoalId	The internal id of the Goal	integer	Required
Description	The description/content of the client report. The text format must match the specified Format (WordML/RTF/PlainText)	string	None
Subjective	The Subjective. This is part of the SOEP model	string	None
Objective	The Objective. This is part of the SOEP model	string	None
Evaluation	The Evaluation. This is part of the SOEP model	string	None
Plan	The Plan. This is part of the SOEP model	string	None
IsSubjectiveVisibleForAllowedDisciplines	Determines if the Subjective is visible for the specified disciplines	boolean	None
IsObjectiveVisibleForAllowedDisciplines	Determines if the Objective is visible for the specified disciplines	boolean	None
IsEvaluationVisibleForAllowedDisciplines	Determines if the Evaluation is visible for the specified disciplines	boolean	None
IsPlanVisibleForAllowedDisciplines	Determines if the Plan is visible for the specified disciplines	boolean	None
LayoutType	The layout of the report. Available options are PlainText and SOEP.	ClientReportingLayout	Required
Format	Describes the format that is used for the Description property	ClientReportFormat	None
OriginalFreeTextFormat	Describes the original format of the Description property. For reading purposes only. If the original format of the clientreport is WordMl, changes cannot be made in PlainText.	OriginalFreeTextFormat	None
Id	The internal id of the report	integer	Required
AggregateId	AggregateId of the report. For reading purposes only.	globally unique identifier	None
ClientId	The internal id of the client	integer	Required
ClientName	The name of the client	string	None
ModifiedDate	The modified date of the client report	date	None
AvailableFor	Determines the read permission for the report. When the value is 'Disciplines', only the specified disciplines can read the report. When the value is 'Everyone', everyone can read the report. The default value is Everyone	AvailableFor	Required
AvailableForDisciplineIds	The list of disciplines ids that are allowed to read the report.	Collection of integer	None
AvailableForDisciplineNames	The list of disciplines that are allowed to read the report. This property is for reading purposes only.	Collection of string	None
AvailableForDisciplineGroupIds	The list of disciplinegroups ids that are allowed to read the report.	Collection of integer	None
AvailableForDisciplineGroupNames	The list of disciplinegroups that are allowed to read the report. This property is for reading purposes only.	Collection of string	None
Subject	The subject of the client report.	string	Conditional Required: Only required for 'General' client report type
Date	The date of the client report.	date	Required
Priority	The priority of the report.	boolean	Required
PriorityText	The priority of the client report. This property is for reading purposes only.	string	None
EmployeeId	The internal id of employee. This property is for reading purposes only. EmployeeId of the provided token will be used when creating a new ClientReport.	integer	Required
EmployeeName	The original creator of the client report. This property is for reading purposes only.	string	None
ShiftId	The internal id of the shift.	integer	Required
Shift	The shift of the client report. This property is for reading purposes only.	string	None
DisciplineId	The internal id of the discipline.	integer	Required
Discipline	The discipline of the client report. This property is for reading purposes only.	string	None
TypeDescription	The type of the client report. This property is for reading purposes only.	string	None
ReportTags	The tags of the client report.	Collection of ReportTag	None
ReportTagsText	The tags of the client report formatted in a string. This property is for reading purposes only.	string	None
AttributeIds	The list of selected attribute id's.	Collection of integer	Deprecated: Please use 'ReportTags' instead.
Attributes	The attributes of the client report. This property is for reading purposes only.	string	Deprecated: Please use 'ReportTagsText' instead.
ParentId	The internal id of the parent client report on which this client report is based.	integer	None
ChildReports	The child reports of the client report.	Collection of ClientReport	None
ContactTypeId	References to a Choice of ChoiceType 'CONTACTTYPE'.	integer	None

Request Formats

application/json, text/json

Sample:

{
  "GoalId": 1,
  "Description": "sample string 2",
  "Subjective": "sample string 3",
  "Objective": "sample string 4",
  "Evaluation": "sample string 5",
  "Plan": "sample string 6",
  "IsSubjectiveVisibleForAllowedDisciplines": true,
  "IsObjectiveVisibleForAllowedDisciplines": true,
  "IsEvaluationVisibleForAllowedDisciplines": true,
  "IsPlanVisibleForAllowedDisciplines": true,
  "LayoutType": 0,
  "Format": 0,
  "OriginalFreeTextFormat": 0,
  "Id": 11,
  "AggregateId": "dccd05dd-b188-446d-874f-93c1cdb67e86",
  "ClientId": 13,
  "ClientName": "sample string 14",
  "ModifiedDate": "2026-05-26T23:13:11.1969198+02:00",
  "AvailableFor": 0,
  "AvailableForDisciplineIds": [
    1,
    2
  ],
  "AvailableForDisciplineNames": [
    "sample string 1",
    "sample string 2"
  ],
  "AvailableForDisciplineGroupIds": [
    1,
    2
  ],
  "AvailableForDisciplineGroupNames": [
    "sample string 1",
    "sample string 2"
  ],
  "Subject": "sample string 16",
  "Date": "2026-05-26T23:13:11.1969198+02:00",
  "Priority": true,
  "PriorityText": "sample string 19",
  "EmployeeId": 20,
  "EmployeeName": "sample string 21",
  "ShiftId": 22,
  "Shift": "sample string 23",
  "DisciplineId": 24,
  "Discipline": "sample string 25",
  "TypeDescription": "sample string 26",
  "ReportTags": [
    {
      "$id": "2",
      "Id": 1,
      "Name": "sample string 2"
    },
    {
      "$ref": "2"
    }
  ],
  "ReportTagsText": "sample string 2; sample string 2",
  "AttributeIds": [
    1,
    2
  ],
  "Attributes": "sample string 27",
  "ParentId": 1,
  "ChildReports": null,
  "ContactTypeId": 1
}

application/xml, text/xml

Sample:

<GoalClientReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.ClientReport">
  <AggregateId>dccd05dd-b188-446d-874f-93c1cdb67e86</AggregateId>
  <AttributeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </AttributeIds>
  <Attributes>sample string 27</Attributes>
  <AvailableFor>Everyone</AvailableFor>
  <AvailableForDisciplineGroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </AvailableForDisciplineGroupIds>
  <AvailableForDisciplineGroupNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AvailableForDisciplineGroupNames>
  <AvailableForDisciplineIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </AvailableForDisciplineIds>
  <AvailableForDisciplineNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AvailableForDisciplineNames>
  <ChildReports i:nil="true" />
  <ClientId>13</ClientId>
  <ClientName>sample string 14</ClientName>
  <ContactTypeId>1</ContactTypeId>
  <Date>2026-05-26T23:13:11.1969198+02:00</Date>
  <Discipline>sample string 25</Discipline>
  <DisciplineId>24</DisciplineId>
  <EmployeeId>20</EmployeeId>
  <EmployeeName>sample string 21</EmployeeName>
  <Id>11</Id>
  <ModifiedDate>2026-05-26T23:13:11.1969198+02:00</ModifiedDate>
  <ParentId>1</ParentId>
  <Priority>true</Priority>
  <PriorityText>sample string 19</PriorityText>
  <ReportTags xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
    <d2p1:ReportTag>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:ReportTag>
    <d2p1:ReportTag>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:ReportTag>
  </ReportTags>
  <Shift>sample string 23</Shift>
  <ShiftId>22</ShiftId>
  <Subject>sample string 16</Subject>
  <TypeDescription>sample string 26</TypeDescription>
  <Description>sample string 2</Description>
  <Evaluation>sample string 5</Evaluation>
  <Format>WordML</Format>
  <IsEvaluationVisibleForAllowedDisciplines>true</IsEvaluationVisibleForAllowedDisciplines>
  <IsObjectiveVisibleForAllowedDisciplines>true</IsObjectiveVisibleForAllowedDisciplines>
  <IsPlanVisibleForAllowedDisciplines>true</IsPlanVisibleForAllowedDisciplines>
  <IsSubjectiveVisibleForAllowedDisciplines>true</IsSubjectiveVisibleForAllowedDisciplines>
  <LayoutType>FreeText</LayoutType>
  <Objective>sample string 4</Objective>
  <OriginalFreeTextFormat>WordMl</OriginalFreeTextFormat>
  <Plan>sample string 6</Plan>
  <Subjective>sample string 3</Subjective>
  <GoalId>1</GoalId>
</GoalClientReport>

Response Information

Resource Description

Returns the HttpResponseMessage which contains the saved goal clientreport instance

HttpResponseMessage

Name	Type	Additional information
Version	Version	None
Content	HttpContent	None
StatusCode	HttpStatusCode	None
ReasonPhrase	string	None
Headers	Collection of Object	None
RequestMessage	HttpRequestMessage	None
IsSuccessStatusCode	boolean	None