GET api/interactions?crmNumber={crmNumber}&interactionTypeId={interactionTypeId}&interactionDateFrom={interactionDateFrom}&interactionDateTo={interactionDateTo}&inactive={inactive}&offset={offset}&limit={limit}&returnTotal={returnTotal}
Get all Interactions optionally filtered by any of the arguments specified in the query string.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| crmNumber |
Optional filter on Interactions that are associated with the Contact Id that matches the provided value. |
integer |
None. |
| interactionTypeId |
Optional filter on Interactions with an associated InteractionType Id that matches the provided value. |
integer |
None. |
| interactionDateFrom |
Optional filter on Interactions that were created on a date from the provided value. |
date |
None. |
| interactionDateTo |
Optional filter on Interactions that were created on a date up to (inclusive) the provided value. |
date |
None. |
| inactive |
Filter indicating whether to retrieve active or inactive records. |
boolean |
Default value is False |
| offset |
The position in the collection of Interactions from which to start returning data from. |
integer |
Default value is 0 |
| limit |
The maximum amount of Interactions that can be returned in any one call. Maximum allowed is 250. |
integer |
Default value is 50 |
| returnTotal |
Whether to include the total amount of Interactions in the database that match the filter specified. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
InteractionDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The primary key of the record in the Hobsons database. Ignored for PUT and 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. Ignored for PUT requests sent to the API. |
integer |
Required (POST only) Range: inclusive between 1 and 2147483647 |
| ExtApplicationId |
The client's application id for this record. |
string |
String length: inclusive between 0 and 100 |
| ExtOfferId |
The client's offer id for this record. |
string |
String length: inclusive between 0 and 100 |
| InteractionTypeId |
A reference to the primary key of the InteractionType record that is associated with this record. |
integer |
Required Range: inclusive between 1 and 99999999 |
| InteractionTypeName |
The name of the InteractionType record that is associated with this record. Ignored for PUT and POST requests sent to the API. |
string |
None. |
| InteractionDate |
The date that the Interaction record was created in the client's system. Ignored for PUT requests sent to the API. |
date |
Required (POST only) Range: inclusive between 1 Jan 1900 and 31 Dec 2099 |
| ContactStatusId |
A reference to the primary key of the ContactStatus record that is associated with this record. |
integer |
Required Range: inclusive between 1 and 99999999 |
| ContactStatusName |
The name of the ContactStatus record that is associated with this record. Ignored for PUT and 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. |
integer |
Required Range: inclusive between 1 and 99999999 |
| IntakeName |
The name of the Intake record that is associated with this record. Ignored for PUT and POST requests sent to the API. |
string |
None. |
| Sponsor |
The name of the sponsor for this record. |
string |
String length: inclusive between 0 and 100 |
| Under18 |
Indicates if this Interaction was for a contact under 18 years old. |
boolean |
None. |
| SubChannelId |
A reference to the primary key of the SubChannel record that is associated with this record. For POST requests sent to the API, the SubChannel record must belong to the parent Channel named 'External'. For PUT requests sent to the API, if changing the SubChannelId, then the new SubChannel record must belong to the parent Channel named 'External'. |
integer |
Required Range: inclusive between 1 and 99999999 |
| SubChannelName |
The name of the SubChannel record that is associated with this record. Ignored for PUT and POST requests sent to the API. |
string |
None. |
| DateCreated |
The date that the Interaction record was created (in the Hobsons database). Ignored for PUT and POST requests sent to the API. |
date |
None. |
| DateUpdated |
The date that the Interaction record was updated (in the Hobsons database). Ignored for PUT and POST requests sent to the API. |
date |
None. |
| Inactive | boolean |
Required |
|
| Task |
The details of the Task record created that it's associated with this record. Used ONLY for PUT and POST requests sent to the API. For GET requests always returned as NULL. |
InnerTaskDto |
None. |
Response Formats
application/json, text/json
{
"Id": 1,
"CrmNumber": 1,
"ExtApplicationId": "sample string 2",
"ExtOfferId": "sample string 3",
"InteractionTypeId": 4,
"InteractionTypeName": "sample string 5",
"InteractionDate": "2024-05-20T09:50:31.5920776+10:00",
"ContactStatusId": 6,
"ContactStatusName": "sample string 7",
"IntakeId": 8,
"IntakeName": "sample string 9",
"Sponsor": "sample string 10",
"Under18": true,
"SubChannelId": 11,
"SubChannelName": "sample string 12",
"DateCreated": "2024-05-20T09:50:31.5920776+10:00",
"DateUpdated": "2024-05-20T09:50:31.5920776+10:00",
"Inactive": true,
"Task": {
"TaskTypeId": 1,
"Description": "sample string 2"
}
}