POST PlanCare2Api/ClientReports/IncidentalMeasureClientReports

Saves a new incidental measure clientreport 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 incidental measure that is being created

Name	Description	Type	Additional information
MeasureId	The internal id of the incidental measure	globally unique identifier	Required
AppliedFrom	The date when the measure is applied	date	Required
AppliedUntil	The date when the measure is ended. Use 2099-12-31 when end of the measure is unknown.	date	Required
Precedence	The situation before applying the measure	string	-
ApplicationReason	The reason why the measure is applied	string	-
Situation	The description of the situation in which the measure is applied	string	-
Completion	The description of how the situation with the client is completed	string	-
MeasureResult	The result after applying the measure	string	-
LegalContactRemarks	The remarks of the legal representative. Only used when LegalContact has value NoWithRemarks	string	-
LegalContact	Defines if there has been contact with the legal representative	MeasureLegalContact	Required
ClientResistance	Describes if the client showed any kind of resistance applying the measure	boolean	Required
ClientResistanceDescription	Description of client resistance	string	-
ApplierId	The internal id of the employee that has applied the measure	integer	Required
Applier	The lookupname of the employee that has applied the measure. This property is for reading purposes only	string	-
RelationNotifyId	The relationId of the employee that should be notified.	integer	Nullable
RelationNotifyLookupName	The lookupname of the employee that should be notified. This property is for reading purposes only.	string	-
Id	The internal id of the report	integer	Required
AggregateId	AggregateId of the report. For reading purposes only.	globally unique identifier	-
ClientId	The internal id of the client	integer	Required
ClientName	The name of the client	string	-
CreationDate	The creation date of the client report	date	-
ModifiedDate	The modified date of the client report	date	-
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	-
AvailableForDisciplineNames	The list of disciplines that are allowed to read the report. This property is for reading purposes only.	Collection of string	-
AvailableForDisciplineGroupIds	The list of disciplinegroups ids that are allowed to read the report.	Collection of integer	-
AvailableForDisciplineGroupNames	The list of disciplinegroups that are allowed to read the report. This property is for reading purposes only.	Collection of string	-
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	-
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	-
ShiftId	The internal id of the shift.	integer	Required
Shift	The shift of the client report. This property is for reading purposes only.	string	-
DisciplineId	The internal id of the discipline.	integer	Required
Discipline	The discipline of the client report. This property is for reading purposes only.	string	-
TypeDescription	The type of the client report. This property is for reading purposes only.	string	-
ReportTags	The tags of the client report.	Collection of ReportTag	-
ReportTagsText	The tags of the client report formatted in a string. This property is for reading purposes only.	string	-
AttributeIds	The list of selected attribute id's.	Collection of integer	Deprecated (unavailable from 21.01.1P): Please use 'ReportTags' instead.
Attributes	The attributes of the client report. This property is for reading purposes only.	string	Deprecated (unavailable from 21.01.1P): Please use 'ReportTagsText' instead.
ParentId	The internal id of the parent client report on which this client report is based.	integer	Nullable
ChildReports	The child reports of the client report.	Collection of ClientReport	-
ContactTypeId	References to a Choice of ChoiceType 'CONTACTTYPE'.	integer	Nullable

Request Formats

application/json, text/json

Sample:

{
  "MeasureId": "af78619c-d468-4aae-aada-acb0ef06e529",
  "AppliedFrom": "2026-05-26T23:13:15.2751233+02:00",
  "AppliedUntil": "2026-05-26T23:13:15.2751233+02:00",
  "Precedence": "sample string 4",
  "ApplicationReason": "sample string 5",
  "Situation": "sample string 6",
  "Completion": "sample string 7",
  "MeasureResult": "sample string 8",
  "LegalContactRemarks": "sample string 9",
  "LegalContact": 0,
  "ClientResistance": true,
  "ClientResistanceDescription": "sample string 11",
  "ApplierId": 12,
  "Applier": "sample string 13",
  "RelationNotifyId": 1,
  "RelationNotifyLookupName": "sample string 14",
  "Id": 15,
  "AggregateId": "3d20bf5d-0c73-49f6-ba62-8e5dbf10cde7",
  "ClientId": 17,
  "ClientName": "sample string 18",
  "CreationDate": "2026-05-26T23:13:15.2751233+02:00",
  "ModifiedDate": "2026-05-26T23:13:15.2751233+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 21",
  "Date": "2026-05-26T23:13:15.2751233+02:00",
  "Priority": true,
  "PriorityText": "sample string 24",
  "EmployeeId": 25,
  "EmployeeName": "sample string 26",
  "ShiftId": 27,
  "Shift": "sample string 28",
  "DisciplineId": 29,
  "Discipline": "sample string 30",
  "TypeDescription": "sample string 31",
  "ReportTags": [
    {
      "$id": "2",
      "Id": 1,
      "Name": "sample string 2"
    },
    {
      "$ref": "2"
    }
  ],
  "ReportTagsText": "sample string 2; sample string 2",
  "AttributeIds": [
    1,
    2
  ],
  "Attributes": "sample string 32",
  "ParentId": 1,
  "ChildReports": null,
  "ContactTypeId": 1
}

application/xml, text/xml

Sample:

<IncidentalMeasureClientReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.ClientReport">
  <AggregateId>3d20bf5d-0c73-49f6-ba62-8e5dbf10cde7</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 32</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>17</ClientId>
  <ClientName>sample string 18</ClientName>
  <ContactTypeId>1</ContactTypeId>
  <CreationDate>2026-05-26T23:13:15.2751233+02:00</CreationDate>
  <Date>2026-05-26T23:13:15.2751233+02:00</Date>
  <Discipline>sample string 30</Discipline>
  <DisciplineId>29</DisciplineId>
  <EmployeeId>25</EmployeeId>
  <EmployeeName>sample string 26</EmployeeName>
  <Id>15</Id>
  <ModifiedDate>2026-05-26T23:13:15.2751233+02:00</ModifiedDate>
  <ParentId>1</ParentId>
  <Priority>true</Priority>
  <PriorityText>sample string 24</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 28</Shift>
  <ShiftId>27</ShiftId>
  <Subject>sample string 21</Subject>
  <TypeDescription>sample string 31</TypeDescription>
  <ApplicationReason>sample string 5</ApplicationReason>
  <AppliedFrom>2026-05-26T23:13:15.2751233+02:00</AppliedFrom>
  <AppliedUntil>2026-05-26T23:13:15.2751233+02:00</AppliedUntil>
  <Applier>sample string 13</Applier>
  <ApplierId>12</ApplierId>
  <ClientResistance>true</ClientResistance>
  <ClientResistanceDescription>sample string 11</ClientResistanceDescription>
  <Completion>sample string 7</Completion>
  <LegalContact>Yes</LegalContact>
  <LegalContactRemarks>sample string 9</LegalContactRemarks>
  <MeasureId>af78619c-d468-4aae-aada-acb0ef06e529</MeasureId>
  <MeasureResult>sample string 8</MeasureResult>
  <Precedence>sample string 4</Precedence>
  <RelationNotifyId>1</RelationNotifyId>
  <RelationNotifyLookupName>sample string 14</RelationNotifyLookupName>
  <Situation>sample string 6</Situation>
</IncidentalMeasureClientReport>

Response Information

Resource Description

Returns the HttpResponseMessage which contains the saved incidental measure clientreport instance

HttpResponseMessage

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