BusinessCategoryResponse
The Get Business Category endpoint returns this response object.
Declaration
object BusinessCategoryResponseProperties
| Name | Type | Description |
|---|---|---|
result | BusinessCategory | The retrieved business category. Omitted from the response entirely if not found (see the 404 case above), rather than being present as |
error | Error | Error details if the request failed. Absent on success. See Error. Read-only. |
Discussion
The Get Business Category returns BusinessCategoryResponse as the top-level envelope. On success, result contains a single BusinessCategory object. On failure (for example, 404 Not Found), the response contains only the error object. The response omits the result key entirely rather than setting it to null.
Example
{
"result": {
"id": "cat-din-001",
"name": "Restaurant",
"qualifiedId": "dining.restaurant",
"description": "Establishments that serve prepared food and beverages for on-site consumption.",
"eligibility": {
"status": "ELIGIBLE",
"blockedGroups": [],
"allowedGroups": []
}
}
}