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	date	Required
Precedence	The situation before applying the measure	string	None.
ApplicationReason	The reason why the measure is applied	string	None.
Situation	The description of the situation in which the measure is applied	string	None.
Completion	The description of how the situation with the client is completed	string	None.
MeasureResult	The result after applying the measure	string	None.
LegalContactRemarks	The remarks of the legal representative. Only used when LegalContact has value NoWithRemarks	string	None.
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
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	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:

{
  "MeasureId": "3ae469c3-1d93-4d7e-a1c4-c71be5465378",
  "AppliedFrom": "2026-05-26T21:01:23.6519031+02:00",
  "AppliedUntil": "2026-05-26T21:01:23.6519031+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,
  "ApplierId": 11,
  "Applier": "sample string 12",
  "Id": 13,
  "AggregateId": "2e75ce50-0756-4f2a-95aa-8e020da0fe6a",
  "ClientId": 15,
  "ClientName": "sample string 16",
  "ModifiedDate": "2026-05-26T21:01:23.6519031+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 18",
  "Date": "2026-05-26T21:01:23.6519031+02:00",
  "Priority": true,
  "PriorityText": "sample string 21",
  "EmployeeId": 22,
  "EmployeeName": "sample string 23",
  "ShiftId": 24,
  "Shift": "sample string 25",
  "DisciplineId": 26,
  "Discipline": "sample string 27",
  "TypeDescription": "sample string 28",
  "ReportTags": [
    {
      "$id": "2",
      "Id": 1,
      "Name": "sample string 2"
    },
    {
      "$ref": "2"
    }
  ],
  "ReportTagsText": "sample string 2; sample string 2",
  "AttributeIds": [
    1,
    2
  ],
  "Attributes": "sample string 29",
  "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>2e75ce50-0756-4f2a-95aa-8e020da0fe6a</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 29</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>15</ClientId>
  <ClientName>sample string 16</ClientName>
  <ContactTypeId>1</ContactTypeId>
  <Date>2026-05-26T21:01:23.6519031+02:00</Date>
  <Discipline>sample string 27</Discipline>
  <DisciplineId>26</DisciplineId>
  <EmployeeId>22</EmployeeId>
  <EmployeeName>sample string 23</EmployeeName>
  <Id>13</Id>
  <ModifiedDate>2026-05-26T21:01:23.6519031+02:00</ModifiedDate>
  <ParentId>1</ParentId>
  <Priority>true</Priority>
  <PriorityText>sample string 21</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 25</Shift>
  <ShiftId>24</ShiftId>
  <Subject>sample string 18</Subject>
  <TypeDescription>sample string 28</TypeDescription>
  <ApplicationReason>sample string 5</ApplicationReason>
  <AppliedFrom>2026-05-26T21:01:23.6519031+02:00</AppliedFrom>
  <AppliedUntil>2026-05-26T21:01:23.6519031+02:00</AppliedUntil>
  <Applier>sample string 12</Applier>
  <ApplierId>11</ApplierId>
  <ClientResistance>true</ClientResistance>
  <Completion>sample string 7</Completion>
  <LegalContact>Yes</LegalContact>
  <LegalContactRemarks>sample string 9</LegalContactRemarks>
  <MeasureId>3ae469c3-1d93-4d7e-a1c4-c71be5465378</MeasureId>
  <MeasureResult>sample string 8</MeasureResult>
  <Precedence>sample string 4</Precedence>
  <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	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.