Branch
Branch List
Use this API to list all branches.
GET /branch/branch-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 branch name |
For general error details, click here.
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"branchList": [
{
"branchId": 7,
"name": "West",
"status": true,
"parentBranchId": 0
}
],
"totalRecords": 1
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| branchList | array of objects | List of branches with details. |
| branchtId | integer | ID of the branch. |
| name | string | Name of the branch. |
| status | boolean | Status of the branch. |
| parentBranchId | integer | ID of the parent branch. |
| totalRecords | integer | Total number of records. |
| Code | Description |
|---|---|
| 1001 | "Invalid firstRecord" |
| 1002 | "Invalid count" |
| 1003 | "Invalid branchId" |