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

Name	Description	Type	Additional 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

Name	Description	Type	Additional information
Id	The identifier of an intervention.	globally unique identifier	-
ActionType	The ActionType of an intervention.	string	-
ActionArea	The ActionArea of an intervention.	string	-
Area	The Area of an intervention.	string	-
AreaId	The internal id of the Area of an intervention.	globally unique identifier	-
Domain	The Domain of an intervention.	string	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": "b91b9ff1-219b-48c5-a1a7-a96e34b1d7aa",
    "ActionType": "sample string 2",
    "ActionArea": "sample string 3",
    "Area": "sample string 4",
    "AreaId": "c950b07f-69f6-4dcd-8c20-c1004f4330e0",
    "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>c950b07f-69f6-4dcd-8c20-c1004f4330e0</AreaId>
    <Domain>sample string 6</Domain>
    <Id>b91b9ff1-219b-48c5-a1a7-a96e34b1d7aa</Id>
  </OmahaIntervention>
  <OmahaIntervention>
    <ActionArea>sample string 3</ActionArea>
    <ActionType>sample string 2</ActionType>
    <Area>sample string 4</Area>
    <AreaId>c950b07f-69f6-4dcd-8c20-c1004f4330e0</AreaId>
    <Domain>sample string 6</Domain>
    <Id>b91b9ff1-219b-48c5-a1a7-a96e34b1d7aa</Id>
  </OmahaIntervention>
</ArrayOfOmahaIntervention>