GET PlanCare2Api/Reports/MetaData?reportLocation={reportLocation}

Gets the available reports for the specified location.

Request Information

URI Parameters

Name Description Type Additional information
reportLocation

The guid of the report location.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

The list of available reports

Collection of ReportingOnLocation
Name Description Type Additional information
Guid

The internal id

globally unique identifier

-

DisplayTitle

The display title

string

-

DisplayDescription

The display description

string

-

LocationGuid

The GUID of the location

globally unique identifier

-

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Guid": "a1d8438e-bdc2-4caa-8603-6be1e794e867",
    "DisplayTitle": "sample string 2",
    "DisplayDescription": "sample string 3",
    "LocationGuid": "f91ef206-66d3-4214-9b23-c07efca2ae16"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfReportingOnLocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
  <ReportingOnLocation>
    <DisplayDescription>sample string 3</DisplayDescription>
    <DisplayTitle>sample string 2</DisplayTitle>
    <Guid>a1d8438e-bdc2-4caa-8603-6be1e794e867</Guid>
    <LocationGuid>f91ef206-66d3-4214-9b23-c07efca2ae16</LocationGuid>
  </ReportingOnLocation>
  <ReportingOnLocation>
    <DisplayDescription>sample string 3</DisplayDescription>
    <DisplayTitle>sample string 2</DisplayTitle>
    <Guid>a1d8438e-bdc2-4caa-8603-6be1e794e867</Guid>
    <LocationGuid>f91ef206-66d3-4214-9b23-c07efca2ae16</LocationGuid>
  </ReportingOnLocation>
</ArrayOfReportingOnLocation>