Firm List
Gets the list of firms.
URL
estate/firms
Method
POST
Request Media type
application/json
Response Media type
application/json
Request Parameters
| Parameter | Data Type | Min | Max | M/O | Sample Value | Comments |
|---|---|---|---|---|---|---|
| key | String | 32 | 32 | M | vQXcoRMMinM2mlK4hqWq3zxAXePNkpwG | Key obtained from authentiaction. |
Response Values
| Name | Data Type | Min Length | Max Length | M/O | Sample Value | Comments |
|---|---|---|---|---|---|---|
| firms | Array | 1 | 250 | M | List of firmid and firmname | |
| firmid | Integer | 1 | 3000 | M | 3 | Firm ID |
| firmname | String | 3 | 64 | M | GRANBY ESTATE | Firm Name |
Sample Request
{
"key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq"
}Sample Success Response
{
"firms": [
{
"firmid": "3",
"firmname": "GRANBY ESTATE"
}
],
"e": 200,
"msg": "Success"
}Sample Failure Responses
{
"e": 407,
"msg": "Resource not found."
}