Retrieves the usage unit associated with a rate schedule
Use this endpoint to determine the unit of measure for a rate schedule. The unit is derived from
the usage unit on the most recent template assigned to a meter with the given rate. Returns 404 if no unit is found.
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 |
|---|---|---|---|
| rateId | Unique numeric identifier of the rate schedule | integer (int32) | Required |
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
UnitResponse
| Property | Description | Type | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unitCode | string | |||||||||||||
| unitId | integer (int32) | |||||||||||||
| unitInfo | string | |||||||||||||
| unitType | UnitType | |||||||||||||
|
UnitType properties
|
||||||||||||||
Example Response
{ "unitCode": "string", "unitId": 1, "unitInfo": "string", "unitType": { "unitTypeCode": "string", "unitTypeId": 1, "unitTypeInfo": "string"
}
}
404
Not Found
The requested resource was not found. Verify the ID or path is correct.