GET v1/module/list
Retrieve list of Modules with minimal information
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
ModuleModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ModuleID |
Unique identifier of a module |
integer |
None. |
| IsCategoryFunction |
Identifies if module is a category function or not |
boolean |
None. |
| IsIncluded |
Identifies if module is included in this environment |
boolean |
None. |
| ModuleCategoryID |
Module Category |
integer |
None. |
| ModuleCategory |
Module Category |
string |
None. |
| ModuleName |
Module name |
string |
None. |
| HasAccessType |
Indicates if module requires read or write permissions |
boolean |
None. |
| CanWrite |
Indicates if user has write permissions |
boolean |
None. |
| ImageURL |
Image associated with the Module |
string |
None. |
| RouteName |
Route Name |
string |
None. |
| APIRole |
Route Name |
string |
None. |
| ModifiedDate | date |
None. |
|
| ModifiedBy | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"moduleID": 1,
"isCategoryFunction": true,
"isIncluded": true,
"moduleCategoryID": 4,
"moduleCategory": "sample string 5",
"moduleName": "sample string 6",
"hasAccessType": true,
"canWrite": true,
"imageURL": "sample string 9",
"routeName": "sample string 10",
"apiRole": "sample string 11",
"modifiedDate": "2025-11-08T10:15:01.6331102+00:00",
"modifiedBy": "sample string 13"
}