GET api/communicationcategories?name={name}&nameContains={nameContains}&inactive={inactive}
Get all CommunicationCategories optionally filtered by any of the arguments specified in the query string.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| name |
Optional case-insensitive filter on CommunicationCategories with a name that matches the provided value. |
string |
None. |
| nameContains |
Optional case-insensitive filter on CommunicationCategories with a name containing the provided value. |
string |
None. |
| inactive |
Filter indicating whether to retrieve active or inactive records. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
CommunicationCategoryDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The primary key of the record in the Hobsons database. |
integer |
None. |
| Name | string |
Required String length: inclusive between 0 and 100 |
|
| Inactive | boolean |
Required |
Response Formats
application/json, text/json
Sample:
{
"Id": 1,
"Name": "sample string 2",
"Inactive": true
}