GET PlanCare2Api/ClientReports/StructuralMeasureClientReports/{reportId}?format={format}

Get structural measure client report by identifier

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

Request Information

URI Parameters

Name	Description	Type	Additional information
reportId	The identifier of the requested report	integer	Required
format	The return format of the description property. When null the original description format is used	ClientReportFormat	None.

Body Parameters

None.

Response Information

Resource Description

The client report

StructuralMeasureClientReport

Name	Description	Type	Additional information
MeasureId	The internal id of the structural measure	globally unique identifier	Required
Content	The content of the client report. The text format must match the specified Format (WordML/RTF)	string	Required
Format	Describes the format that is used for the Content property	ClientReportFormat	Required
OriginalFreeTextFormat	Describes the original format of the Description property. For reading purposes only. A clientreport format can't be saved in a different format other than the original.	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.

Response Formats

application/json, text/json

Sample:

{
  "MeasureId": "0c5ab08c-4814-459b-b222-6304d8758f85",
  "Content": "sample string 2",
  "Format": 0,
  "OriginalFreeTextFormat": 0,
  "Id": 3,
  "AggregateId": "8613471d-daff-462a-a5a8-de1c345d9f78",
  "ClientId": 5,
  "ClientName": "sample string 6",
  "ModifiedDate": "2026-05-26T21:01:12.5725966+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 8",
  "Date": "2026-05-26T21:01:12.5725966+02:00",
  "Priority": true,
  "PriorityText": "sample string 11",
  "EmployeeId": 12,
  "EmployeeName": "sample string 13",
  "ShiftId": 14,
  "Shift": "sample string 15",
  "DisciplineId": 16,
  "Discipline": "sample string 17",
  "TypeDescription": "sample string 18",
  "ReportTags": [
    {
      "$id": "2",
      "Id": 1,
      "Name": "sample string 2"
    },
    {
      "$ref": "2"
    }
  ],
  "ReportTagsText": "sample string 2; sample string 2",
  "AttributeIds": [
    1,
    2
  ],
  "Attributes": "sample string 19",
  "ParentId": 1,
  "ChildReports": null,
  "ContactTypeId": 1
}

application/xml, text/xml

Sample:

<StructuralMeasureClientReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.ClientReport">
  <AggregateId>8613471d-daff-462a-a5a8-de1c345d9f78</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 19</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>5</ClientId>
  <ClientName>sample string 6</ClientName>
  <ContactTypeId>1</ContactTypeId>
  <Date>2026-05-26T21:01:12.5725966+02:00</Date>
  <Discipline>sample string 17</Discipline>
  <DisciplineId>16</DisciplineId>
  <EmployeeId>12</EmployeeId>
  <EmployeeName>sample string 13</EmployeeName>
  <Id>3</Id>
  <ModifiedDate>2026-05-26T21:01:12.5725966+02:00</ModifiedDate>
  <ParentId>1</ParentId>
  <Priority>true</Priority>
  <PriorityText>sample string 11</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 15</Shift>
  <ShiftId>14</ShiftId>
  <Subject>sample string 8</Subject>
  <TypeDescription>sample string 18</TypeDescription>
  <Content>sample string 2</Content>
  <Format>WordML</Format>
  <OriginalFreeTextFormat>WordMl</OriginalFreeTextFormat>
  <MeasureId>0c5ab08c-4814-459b-b222-6304d8758f85</MeasureId>
</StructuralMeasureClientReport>