Retrieve a meter group category
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type. |
Path Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| categoryId | The identifier for the meter group category being retrieved | integer (int32) | Required |
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
MeterCategoryResponse
| Property | Description | Type |
|---|---|---|
| autoGroup | Is this category an automatically maintained one? | boolean |
| meterGroupCategoryCode | The meter category code | string |
| meterGroupCategoryId | The meter category identifier | integer (int32) |
| meterGroupCategoryInfo | The meter category name | string |
| numberOfGroups | Number of groups within this category | integer (int32) |
| numberOfGroupsWithVisibleMembers | Number of groups within this category with members the logged in can see | integer (int32) |
Example Response
{ "autoGroup": false, "meterGroupCategoryCode": "string", "meterGroupCategoryId": 1, "meterGroupCategoryInfo": "string", "numberOfGroups": 1, "numberOfGroupsWithVisibleMembers": 1
}