Department
Department List
Use this API to list all departments.
GET /department/department-list Try now
Query string parameters
| Field | Type | Description |
|---|---|---|
| firstRecord required | integer | First record to return. Default: 1 |
| count required | integer | Number of records to be returned from the first record Default: 20, Max count limit: 100 |
| q | string | filter data by department name |
For general error details, click here.
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"departmentList": [
{
"departmentId": 14,
"name": "Marketing",
"status": true
}
],
"totalRecords": 1
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| departmentList | array of objects | List of departments with details. |
| departmentId | integer | ID of the department. |
| name | string | Name of the department. |
| status | boolean | Status of the department. |
| totalRecords | integer | Total number of records. |
| Code | Description |
|---|---|
| 1003 | "Invalid firstRecord" |
| 1004 | "Invalid count" |