Department
Department List
Use this API to get all departments.
GET /department/department-list
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 |
- 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 |
---|---|---|
departmentId | integer | Department ID |
name | string | Department Name |
status | integer | Enabled/Disabled |
totalRecords | integer | count of records returned |
Code | Description |
---|---|
1003 | "Invalid firstRecord" |
1004 | "Invalid count" |
For general error details, click here.