GET api/ActivityTypes?includeInactive={includeInactive}
Get all activity types
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| includeInactive |
Controls whether or not to include activity types marked as inactive in the database. |
boolean |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of ActivityType| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| Name | string |
None. |
|
| Description | string |
None. |
|
| IsActive | boolean |
None. |
|
| IsCustom | boolean |
None. |
|
| ActivityTypeGuid | globally unique identifier |
None. |
|
| Image | string |
None. |
|
| HistoryTypes | Collection of HistoryType |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ID": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"IsActive": true,
"IsCustom": true,
"ActivityTypeGuid": "1609ab8c-45a2-4633-9e99-51bacc8819a5",
"Image": "sample string 7",
"HistoryTypes": [
{
"Name": "sample string 1",
"HistoryTypeId": 2,
"Description": "sample string 3",
"ActivityTypeID": "sample string 4",
"ActivityTypeName": "sample string 5",
"IsActive": true,
"IsCustom": true,
"IsDefault": true,
"IsUserRecordable": true
},
{
"Name": "sample string 1",
"HistoryTypeId": 2,
"Description": "sample string 3",
"ActivityTypeID": "sample string 4",
"ActivityTypeName": "sample string 5",
"IsActive": true,
"IsCustom": true,
"IsDefault": true,
"IsUserRecordable": true
}
]
},
{
"ID": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"IsActive": true,
"IsCustom": true,
"ActivityTypeGuid": "1609ab8c-45a2-4633-9e99-51bacc8819a5",
"Image": "sample string 7",
"HistoryTypes": [
{
"Name": "sample string 1",
"HistoryTypeId": 2,
"Description": "sample string 3",
"ActivityTypeID": "sample string 4",
"ActivityTypeName": "sample string 5",
"IsActive": true,
"IsCustom": true,
"IsDefault": true,
"IsUserRecordable": true
},
{
"Name": "sample string 1",
"HistoryTypeId": 2,
"Description": "sample string 3",
"ActivityTypeID": "sample string 4",
"ActivityTypeName": "sample string 5",
"IsActive": true,
"IsCustom": true,
"IsDefault": true,
"IsUserRecordable": true
}
]
}
]