Department List

Use this API to get all departments.

 

HTTP REQUEST

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 starting from the first record.
Default: 20, Max count limit: 100
q string filter data by department name
{
    "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
1002 ‘Invalid firstRecord’
1003 ‘Invalid count’

For general error details, click here.