GET PlanCare2Api/Clients/{clientId}/ReportSubjects

Returns a list of subjects that can be used on reports.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	The internal Id of the client the report subjects are requested for	integer	Required

Body Parameters

None.

Response Information

Resource Description

List of ReportSubject records

Collection of ReportSubject

Name	Description	Type	Additional information
Id	The internal id of the report subject	integer	None.
Description	The description of the report subject	string	None.
Value	The value of the report subject	string	None.
Sectors	The sectors the subject is used for	Collection of Sector	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "Description": "sample string 2",
    "Value": "sample string 3",
    "Sectors": [
      {
        "$id": "2",
        "Id": 1,
        "Name": "sample string 2"
      },
      {
        "$ref": "2"
      }
    ]
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfReportSubject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Client">
  <ReportSubject>
    <Description>sample string 2</Description>
    <Id>1</Id>
    <Sectors>
      <Sector>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </Sector>
      <Sector>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </Sector>
    </Sectors>
    <Value>sample string 3</Value>
  </ReportSubject>
  <ReportSubject>
    <Description>sample string 2</Description>
    <Id>1</Id>
    <Sectors>
      <Sector>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </Sector>
      <Sector>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </Sector>
    </Sectors>
    <Value>sample string 3</Value>
  </ReportSubject>
</ArrayOfReportSubject>