An action to be performed by a user, optionally at a scheduled date and time.
A unique Id for the assessment.
A unique number assigned to the action for easy reference.
The assessment the action relates to.
The user the action is assigned to.
The care enquiry the action relates to.
The comment the action relates to.
The date/time the action was completed.
The date/time the assessment was created.
The date/time the action is due.
The home visit the action relates to.
The Id of the location the action relates to (based on the subject of the action).
The parent subject (if any) for the action, for example an action related to an assessment would have a parent subject referencing the related care enquiry.
A list of of notification groups to notify when the action is marked as complete.
The care enquiry or service user the action relates to.
The subject type (if any) of the parent the action relates to; |('care_enquiry', 'service_user').
The calender (if any) the action is pinned to (will appear on); location, user.
A list of reminders set for the action (at most 2).
The service user the action relates to.
The subject type (if any) the action relates to; assessment, care_enquiry, comment, location, home_visit, service_user.
A tag assigned to the action when created to help identify automatically generated actions (this is set by the application and cannot be set by a user or via the API).
A decription of the task to be performed for the action to be be completed.
Flag indicating if the action is urgent (urgent actions always appear at the top of a user's dashboard).
A list of action tags assigned to the action.
{
"_id": "6724fbcb4f73a2cebf638856",
"action_no": "1",
"assessment": "6724fbca4f73a2cebf63857e",
"assigned_to": "6724fbc74f73a2cebf637806",
"care_enquiry": null,
"comment": null,
"completed": null,
"created": "2024-11-01 16:03:23",
"due": "2024-11-14 14:30:00",
"home_visit": null,
"location": "6724fbc74f73a2cebf6377fa",
"modified": "2024-11-01 16:03:23",
"notify_on_complete": [],
"parent_subject": "6724fbca4f73a2cebf638579",
"parent_subject_type": "care_enquiry",
"pin_to_calendar": null,
"reminders": [],
"service_users": null,
"subject_type": "assessment",
"tag": "care_enquiry__perform_assessment",
"task": "Record outcome of assessment for the service user.",
"urgent": false,
"user_tags": []
}
The Id of user the action should be assigned to.
The Id of the care enquiry the action relates to.
The date/time the action is due to be completed by.
A list of Ids for notification groups to notify when the action is marked as complete.
none
none
The Id of the service user the action relates to.
A description of the task to complete.
A flag indicating if the action is urgent.
A list of action tags (groups) Ids assigned to the action.
Returns the action object created.
var action = apiClient.Request(
HttpMethod.Put,
"actions",
null,
new MultDict()
.Add("assigned_to", userId)
.Add("care_enquiry", careEnquiryId),
.Add("due", dueDateTime),
.Add("reminders_0-offset_type", "delta"),
.Add("reminders_0-offset_delta", 15),
.Add("reminders_0-method", "email"),
.Add(
"task",
"Call Bob to see if he has an update on his when his " +
"father is leaving hospital."
)
);
<?php
$action = $api_client->request(
'PUT',
'actions',
NULL
[
'assigned_to'=>$user_id,
'care_enquiry'=>$care_enquiry_id,
'due'=>$due_date_time,
'reminders_0-offset_type'=>'delta',
'reminders_0-offset_delta'=>15,
'reminders_0-method'=>'email',
'task'=>'Call Bob to see if he has an update on his when his father is '
. 'leaving hospital.'
]
);
action = api_client(
'PUT',
'actions',
data={
'assigned_to': user_id,
'care_enquiry': care_enquiry_id,
'due': due_date_time,
'reminders_0-offset_type': 'delta',
'reminders_0-offset_delta': 15,
'reminders_0-method': 'email',
'task': (
'Call Bob to see if he has an update on his when his father is'
'leaving hospital.'
)
}
)
action = api_client.request(
'PUT',
'actions',
data: {
'assigned_to' => user_id,
'care_enquiry' => care_enquiry_id,
'due' => due_date_time,
'reminders_0-offset_type' => 'delta',
'reminders_0-offset_delta' => 15,
'reminders_0-method' => 'email',
'task' => 'Call Bob to see if he has an update on his when his father ' +
'is leaving hospital.'
}
)
{
"_id": "6724fbd23cd2cde34170f2b1",
"action_no": "8",
"assigned_to": null,
"care_enquiry": "6724fbd24f73a2cebf638f09",
"completed": null,
"created": "2024-11-01 16:03:30",
"due": "2024-11-03 11:00:00",
"location": "6724fbc74f73a2cebf6377fa",
"modified": "2024-11-01 16:03:30",
"notify_on_complete": [],
"parent_subject": "6724fbd24f73a2cebf638f09",
"pin_to_calendar": null,
"reminders": [
{
"method": "email",
"offset_delta": 15,
"offset_time_str": null,
"offset_type": "delta"
}
],
"subject_type": "care_enquiry",
"task": "Call Bob to see if he has an update on his when his father isleaving hospital.",
"urgent": false,
"user_tags": []
}
Return a list of actions.
['_id']
A list of attributes to include for fetched objects.
A filter that accepts a list of user Ids and filters actions by the user they are assigned to.
unset
A filter that allows assessments to be filtered by whether the assessment is completed.
A filter that accepts a date and filters actions to those due before or on the end date.
A filter that accepts a list of Ids and filters the items returned to those with an Id in the list.
A filter that accepts a date/time and filters the items returned to those modified after the date/time.
A filter that accepts a date/time and filters the items returned to those modified before the date/time.
A filter that accepts a list of care enquiry and/or service user Ids and filters actions by the subject the actions are associated with.
A case insensitive keyword filter applied to the following fields; action_no, task.
A filter that accepts a date and filters actions to those due after or on the start date.
unset
A filter that allows actions to be filtered by whether the action is urgent.
1
The page number to fetch.
10
The number of items to return per page.
_id
A list of fields the returned items can be sorted by. Fields prefixed with minus (-) sign are sorted in descending order.
Returns a page of actions.
var actions = apiClient.Request(
HttpMethod.Get,
"actions",
new MultiValueDict()
.Add("attributes", "action_no", "task")
.Add("filters-q", "hair dressing")
}
);
<?php
$actions = $api_client->request(
'GET',
'actions',
[
'attributes'=>['action_no', 'task'],
'filters-q'=>'hair dressing'
]
);
actions = api_client(
'GET',
'actions',
params={
'attributes': ['action_no', 'task'],
'filters-q': 'hair dressing'
}
)
actions = api_client.request(
'GET',
'actions',
params: {
'attributes' => ['action_no', 'task'],
'filters-q' => 'hair dressing'
}
)
{
"item_count": 1,
"items": [
{
"_id": "6724fbcb4f73a2cebf638858",
"action_no": "2",
"task": "Confirm costs of hair dressing appointment for Anna with her daughter."
}
],
"page": 1,
"page_count": 1,
"per_page": 10
}
var action = apiClient.Request(HttpMethod.Get, $"actions/{actionId}")
<?php
$action = $api_client->request('GET', 'actions/' . $action_id);
action = api_client('GET', f'actions/{action_id}')
action = api_client.request('GET', "actions/#{action_id}")
{
"_id": "6724fbcb4f73a2cebf638856",
"action_no": "1",
"assessment": "6724fbca4f73a2cebf63857e",
"assigned_to": "6724fbc74f73a2cebf637806",
"care_enquiry": null,
"comment": null,
"completed": null,
"created": "2024-11-01 16:03:23",
"due": "2024-11-14 14:30:00",
"home_visit": null,
"location": "6724fbc74f73a2cebf6377fa",
"modified": "2024-11-01 16:03:23",
"notify_on_complete": [],
"parent_subject": "6724fbca4f73a2cebf638579",
"parent_subject_type": "care_enquiry",
"pin_to_calendar": null,
"reminders": [],
"service_users": null,
"subject_type": "assessment",
"tag": "care_enquiry__perform_assessment",
"task": "Record outcome of assessment for the service user.",
"urgent": false,
"user_tags": []
}
The Id of user the action should be assigned to.
The date/time the action is due to be completed by.
A list of Ids for notification groups to notify when the action is marked as complete.
none
none
A description of the task to complete.
A flag indicating if the action is urgent.
A list of action tags (groups) Ids assigned to the action.
Returns the action object updated.
var action = apiClient.Request(
HttpMethod.Put,
$"actions/{action_id}",
null,
new MultiValueDict()
.Add(
"task",
"Check with Bob if he has a time his father will be " +
"checking in on Friday."
)
);
<?php
$comment = $api_client->request(
'PATCH',
'actions/' . action_id,
NULL
[
'task'=>'Check with Bob if he has a time his father will be checking '
. 'in on Friday.'
]
);
action = api_client(
'PATCH',
f'actions/{action_id}',
data={
'task': (
'Check with Bob if he has a time his father will be checking '
'in on Friday.'
),
'urgent': True
}
)
action = api_client.request(
'PUT',
"actions/#{action_id}",
data: {
'task'=>'Check with Bob if he has a time his father will be ' +
'checking in on Friday.'
}
)
{
"_id": "6724fbd34f73a2cebf638f17",
"action_no": "12",
"assigned_to": "6724fbc74f73a2cebf637800",
"care_enquiry": "6724fbd34f73a2cebf638f13",
"completed": null,
"created": "2024-11-01 16:03:31",
"due": "2024-11-03 11:00:00",
"modified": "2024-11-01 16:03:31",
"notify_on_complete": [],
"parent_subject": "6724fbd34f73a2cebf638f13",
"pin_to_calendar": null,
"reminders": [
{
"method": "email",
"offset_delta": 15,
"offset_time_str": null,
"offset_type": "delta"
}
],
"subject_type": "care_enquiry",
"task": "Check with Bob if he has a time his father will be checking in on Friday.",
"urgent": true,
"user_tags": []
}
var actions = apiClient.Request(
HttpMethod.Patch,
$"actions/{actionId}/complete"
);
<?php
$action = $api_client->request(
'PATCH',
'actions/' . action_id . '/complete'
);
action = api_client(
'PATCH',
f'actions/{action_id}/complete'
)
actions = api_client.request(
'PATCH',
"actions/#{action_id}/complete"
)
{
"_id": "6724fbd24f73a2cebf638f07",
"action_no": "6",
"assigned_to": "6724fbc74f73a2cebf637800",
"care_enquiry": "6724fbd24f73a2cebf638f03",
"completed": "2024-11-01 16:03:30",
"created": "2024-11-01 16:03:30",
"due": "2024-11-03 11:00:00",
"modified": "2024-11-01 16:03:30",
"notify_on_complete": [],
"parent_subject": "6724fbd24f73a2cebf638f03",
"reminders": [
{
"method": "email",
"offset_delta": 15,
"offset_type": "delta"
}
],
"subject_type": "care_enquiry",
"task": "Call Bob to see if he has an update on his when his father isleaving hospital.",
"urgent": false,
"user_tags": []
}
var actions = apiClient.Request(
HttpMethod.Patch,
$"actions/{actionId}/reopen"
);
<?php
$action = $api_client->request(
'PATCH',
'actions/' . action_id . '/reopen'
);
action = api_client(
'PATCH',
f'actions/{action_id}/reopen'
)
actions = api_client.request(
'PATCH',
"actions/#{action_id}/reopen"
)
{
"_id": "6724fbd34f73a2cebf638f11",
"action_no": "10",
"assigned_to": "6724fbc74f73a2cebf637800",
"care_enquiry": "6724fbd34f73a2cebf638f0d",
"completed": null,
"created": "2024-11-01 16:03:31",
"due": "2024-11-03 11:00:00",
"modified": "2024-11-01 16:03:31",
"notify_on_complete": [],
"parent_subject": "6724fbd34f73a2cebf638f0d",
"reminders": [
{
"method": "email",
"offset_delta": 15,
"offset_type": "delta"
}
],
"subject_type": "care_enquiry",
"task": "Call Bob to see if he has an update on his when his father isleaving hospital.",
"urgent": false,
"user_tags": []
}