GET PlanCare2Api/Interventions?clientId={clientId}

Retrieves a list of interventions that belong to clientplans of the client that have the status 'In progress'.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

The client for whom to fetch the interventions.

integer

Required

Body Parameters

None.

Response Information

Resource Description

A list of interventions that belong to clientplans of the client that have the status 'In progress'.

Collection of OmahaIntervention
NameDescriptionTypeAdditional information
Id

The identifier of an intervention.

globally unique identifier

None

ActionType

The ActionType of an intervention.

string

None

ActionArea

The ActionArea of an intervention.

string

None

Area

The Area of an intervention.

string

None

AreaId

The internal id of the Area of an intervention.

globally unique identifier

None

Domain

The Domain of an intervention.

string

None

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Id": "ed407fbe-1a6b-4598-a683-79696577dd2a",
    "ActionType": "sample string 2",
    "ActionArea": "sample string 3",
    "Area": "sample string 4",
    "AreaId": "bf94ad9a-ae1c-4817-b7bd-f227cb1b8998",
    "Domain": "sample string 6"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfOmahaIntervention xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <OmahaIntervention>
    <ActionArea>sample string 3</ActionArea>
    <ActionType>sample string 2</ActionType>
    <Area>sample string 4</Area>
    <AreaId>bf94ad9a-ae1c-4817-b7bd-f227cb1b8998</AreaId>
    <Domain>sample string 6</Domain>
    <Id>ed407fbe-1a6b-4598-a683-79696577dd2a</Id>
  </OmahaIntervention>
  <OmahaIntervention>
    <ActionArea>sample string 3</ActionArea>
    <ActionType>sample string 2</ActionType>
    <Area>sample string 4</Area>
    <AreaId>bf94ad9a-ae1c-4817-b7bd-f227cb1b8998</AreaId>
    <Domain>sample string 6</Domain>
    <Id>ed407fbe-1a6b-4598-a683-79696577dd2a</Id>
  </OmahaIntervention>
</ArrayOfOmahaIntervention>