GET PlanCare2Api/Actions?clientId={clientId}
Retrieves a list of actions that belong to legacy clientplans of the client that have the status 'In progress'. Note: This endpoint is obsolete and will be deleted in a future version of the API. Use the endpoint PlanCare2Api/ActionsV2/ instead. This endpoint will return both legacy and current clientplan actions.
Deprecated (unavailable from 21.01.1P): use PlanCare2Api/ActionsV2 instead
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
The client for whom to fetch the actions. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of actions that belong to clientplans of the client that have the status 'In progress'.
Collection of Action| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The internal id of the action. |
integer |
None |
| Name |
The name of the action. |
string |
None |
| IsLegacy |
Determines if the action is a legacy action or not. |
boolean |
None |
Response Formats
application/json, text/json
Sample:
[
{
"$id": "1",
"Id": 1,
"Name": "sample string 2",
"IsLegacy": true
},
{
"$ref": "1"
}
]
application/xml, text/xml
Sample:
<ArrayOfAction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
<Action>
<Id>1</Id>
<IsLegacy>true</IsLegacy>
<Name>sample string 2</Name>
</Action>
<Action>
<Id>1</Id>
<IsLegacy>true</IsLegacy>
<Name>sample string 2</Name>
</Action>
</ArrayOfAction>