GET api/contacts/{id}/activities?dateCreatedFrom={dateCreatedFrom}&dateCreatedTo={dateCreatedTo}&contactStatusId={contactStatusId}&intakeId={intakeId}
Get all Activities that are related to the supplied Contact id and optionally filtered by any of the arguments specified in the query string.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The primary key of the Contact record. |
integer |
Required |
| dateCreatedFrom |
Optional filter on Activities that were created on a date from the provided value. |
date |
None. |
| dateCreatedTo |
Optional filter on Activities that were created on a date up to (inclusive) the provided value. |
date |
None. |
| contactStatusId |
Optional filter on Activities with an associated ContactStatus Id that matches the provided value. |
integer |
None. |
| intakeId |
Optional filter on Activities with an associated Intake Id that matches the provided value. |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
ActivityDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The primary key of the record in the Hobsons database. Ignored for POST requests sent to the API. |
integer |
None. |
| CrmNumber |
A reference to the primary key of the Contact record that is associated with this record. |
integer |
Required Range: inclusive between 1 and 2147483647 |
| ContactStatusId |
A reference to the primary key of the ContactStatus record that is associated with this record. For POST requests sent to the API if this value is not provided it will be set to the Default ContactStatus record. |
integer |
Range: inclusive between 1 and 99999999 |
| ContactStatusName |
The name of the ContactStatus record that is associated with this record. Ignored for POST requests sent to the API. |
string |
None. |
| IntakeId |
A reference to the primary key of the Intake record that is associated with this record. For POST requests sent to the API if this value is not provided it will be set to the Default Intake record. |
integer |
Range: inclusive between 1 and 99999999 |
| IntakeName |
The name of the Intake record that is associated with this record. Ignored for POST requests sent to the API. |
string |
None. |
| DateCreated |
The date that the Activity record was created (in the Hobsons database). Ignored for POST requests sent to the API. |
date |
None. |
| Task |
The details of the Task record created that it's associated with this record. Used ONLY for POST requests sent to the API. For GET requests always returned as NULL. |
InnerTaskDto |
None. |
Response Formats
application/json, text/json
{
"Id": 1,
"CrmNumber": 2,
"ContactStatusId": 1,
"ContactStatusName": "sample string 3",
"IntakeId": 1,
"IntakeName": "sample string 4",
"DateCreated": "2024-05-20T10:35:43.969223+10:00",
"Task": {
"TaskTypeId": 1,
"Description": "sample string 2"
}
}