GET PlanCare2Api/ClientplansV2/{clientplanId}/omaha/{clientplanOmahaAreaId}/measurements

Retrieves the ClientplanOmahaAreaMeasurements for the provided measurement.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientplanId

The clientplan ID.

integer

Required

clientplanOmahaAreaId

The clientplanOmahaArea ID.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

A list of ClientplanOmahaAreaMeasurement

Collection of ClientplanOmahaAreaMeasurement
NameDescriptionTypeAdditional information
Id

The internal id of the ClientplanOmahaAreaMeasurement

globally unique identifier

None

Date

The date of the ClientplanOmahaAreaMeasurement

date

None

KnowledgeSampleValue

The sample value of the knowledge aspect

string

None

KnowledgeSampleLevel

The sample level of the knowledge aspect

integer

None

KnowledgeSetpointValue

The setpoint value of the knowledge aspect

string

None

KnowledgeSetpointLevel

The setpoint level of the knowledge aspect

integer

None

BehaviorSampleValue

The sample value of the behavior aspect

string

None

BehaviorSampleLevel

The sample level of the behavior aspect

integer

None

BehaviorSetpointValue

The setpoint value of the behavior aspect

string

None

BehaviorSetpointLevel

The setpoint level of the behavior aspect

integer

None

StatusSampleValue

The sample value of the status aspect

string

None

StatusSampleLevel

The sample value of the status aspect

integer

None

StatusSetpointValue

The sample value of the status aspect

string

None

StatusSetpointLevel

The setpoint value of the status aspect

integer

None

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Id": "751edc84-dad3-4bed-bad1-a4cb05cd8913",
    "Date": "2026-05-26T21:12:47.6036601+02:00",
    "KnowledgeSampleValue": "sample string 3",
    "KnowledgeSampleLevel": 4,
    "KnowledgeSetpointValue": "sample string 5",
    "KnowledgeSetpointLevel": 6,
    "BehaviorSampleValue": "sample string 7",
    "BehaviorSampleLevel": 8,
    "BehaviorSetpointValue": "sample string 9",
    "BehaviorSetpointLevel": 10,
    "StatusSampleValue": "sample string 11",
    "StatusSampleLevel": 12,
    "StatusSetpointValue": "sample string 13",
    "StatusSetpointLevel": 14
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfClientplanOmahaAreaMeasurement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <ClientplanOmahaAreaMeasurement>
    <BehaviorSampleLevel>8</BehaviorSampleLevel>
    <BehaviorSampleValue>sample string 7</BehaviorSampleValue>
    <BehaviorSetpointLevel>10</BehaviorSetpointLevel>
    <BehaviorSetpointValue>sample string 9</BehaviorSetpointValue>
    <Date>2026-05-26T21:12:47.6036601+02:00</Date>
    <Id>751edc84-dad3-4bed-bad1-a4cb05cd8913</Id>
    <KnowledgeSampleLevel>4</KnowledgeSampleLevel>
    <KnowledgeSampleValue>sample string 3</KnowledgeSampleValue>
    <KnowledgeSetpointLevel>6</KnowledgeSetpointLevel>
    <KnowledgeSetpointValue>sample string 5</KnowledgeSetpointValue>
    <StatusSampleLevel>12</StatusSampleLevel>
    <StatusSampleValue>sample string 11</StatusSampleValue>
    <StatusSetpointLevel>14</StatusSetpointLevel>
    <StatusSetpointValue>sample string 13</StatusSetpointValue>
  </ClientplanOmahaAreaMeasurement>
  <ClientplanOmahaAreaMeasurement>
    <BehaviorSampleLevel>8</BehaviorSampleLevel>
    <BehaviorSampleValue>sample string 7</BehaviorSampleValue>
    <BehaviorSetpointLevel>10</BehaviorSetpointLevel>
    <BehaviorSetpointValue>sample string 9</BehaviorSetpointValue>
    <Date>2026-05-26T21:12:47.6036601+02:00</Date>
    <Id>751edc84-dad3-4bed-bad1-a4cb05cd8913</Id>
    <KnowledgeSampleLevel>4</KnowledgeSampleLevel>
    <KnowledgeSampleValue>sample string 3</KnowledgeSampleValue>
    <KnowledgeSetpointLevel>6</KnowledgeSetpointLevel>
    <KnowledgeSetpointValue>sample string 5</KnowledgeSetpointValue>
    <StatusSampleLevel>12</StatusSampleLevel>
    <StatusSampleValue>sample string 11</StatusSampleValue>
    <StatusSetpointLevel>14</StatusSetpointLevel>
    <StatusSetpointValue>sample string 13</StatusSetpointValue>
  </ClientplanOmahaAreaMeasurement>
</ArrayOfClientplanOmahaAreaMeasurement>