BusinessCategoryQueryResponse
The Query Business Categories endpoint returns this response object.
Declaration
object BusinessCategoryQueryResponseProperties
| Name | Type | Description |
|---|---|---|
result | [BusinessCategory] | Array of matching business categories. See BusinessCategory. Read-only. |
pagination | QueryPaginationResult | Pagination metadata. See QueryPaginationResult. Read-only. |
error | Error | Error details if the request failed. Absent on success. See Error. Read-only. |
Discussion
The Query Business Categories returns BusinessCategoryQueryResponse as the top-level envelope. It extends the standard QueryResponse envelope: on success, result contains an array of BusinessCategory objects matching the query criteria. The standard pagination field handles pagination.
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": []
}
}
],
"pagination": {
"totalCount": 1,
"offset": 0,
"pageSize": 20
}
}