openapi: 3.2.0 info: title: Eliq Data Management Meter Energy High Resolution API description: '# API Reference The Eliq data management API is organized around REST.' contact: name: Support email: support_b2b@eliq.com version: 1.5.2 tags: - name: Meter Energy High Resolution paths: /meters/{id}/energy/highres/{resolution}: post: tags: - Meter Energy High Resolution summary: Creates or updates high resolution (hourly or higher) energy data for a meter operationId: post-high-resolution-energy-meterid parameters: - name: id in: path description: Meter external reference required: true schema: type: string - name: resolution in: path description: Resolution of the data provided required: true schema: type: string requestBody: description: High resolution energy object to create or update content: application/json: schema: type: array items: $ref: '#/components/schemas/EnergyHighResolutionData' examples: Energy high resolution data: value: - interval_start: '2024-01-01T00:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T01:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T02:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T03:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T04:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T05:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T06:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T07:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T08:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T09:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T10:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T11:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T12:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T13:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T14:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T15:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T16:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T17:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T18:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T19:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T20:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T21:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T22:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T23:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-02T00:00:00Z' energy_wh: 1000.0 is_estimated: false responses: '204': description: No Content content: application/json: schema: $ref: '#/components/schemas/NoContentResult' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Request input is missing. This may be caused by incorrect format of input.: value: code: INPUT_MISSING description: Request input is missing. This may be caused by incorrect format of input. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'id' must not be null or empty: value: code: METER_ID_MISSING description: Parameter 'id' must not be null or empty request_id: 65e2ea86-470f-4363-9295-35d6b473981a Resolution must not be null or empty: value: code: RESOLUTION_MISSING description: Resolution must not be null or empty request_id: 65e2ea86-470f-4363-9295-35d6b473981a 'Invalid resolution. Must be one of: [hour, 30min, 15min, 10min, 6min]': value: code: RESOLUTION_INVALID description: 'Invalid resolution. Must be one of: [hour, 30min, 15min, 10min, 6min]' request_id: 65e2ea86-470f-4363-9295-35d6b473981a Maximum limit of element per request exceeded. Please refer to documentation for more information: value: code: ENERGY_SEQUENCE_LENGTH_LIMIT_EXCEEDED description: Maximum limit of element per request exceeded. Please refer to documentation for more information request_id: 65e2ea86-470f-4363-9295-35d6b473981a Energy elements in sequence must be unique: value: code: ENERGY_SEQUENCE_CONTAINS_DUPLICATE_ELEMENTS description: Energy elements in sequence must be unique request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'energy_wh' must not be negative: value: code: ENERGY_ELEMENT_ENERGY_WH_INVALID description: Parameter 'energy_wh' must not be negative request_id: 65e2ea86-470f-4363-9295-35d6b473981a Element in sequence must have either parameter 'energy_wh' or 'energy_m3': value: code: ENERGY_ELEMENT_ENERGY_WH_AND_ENERGY_M3_MISSING description: Element in sequence must have either parameter 'energy_wh' or 'energy_m3' request_id: 65e2ea86-470f-4363-9295-35d6b473981a Element in sequence must have either parameter 'energy_wh' or 'energy_m3' but not both: value: code: ENERGY_ELEMENT_BOTH_ENERGY_WH_AND_ENERGY_M3_SET description: Element in sequence must have either parameter 'energy_wh' or 'energy_m3' but not both request_id: 65e2ea86-470f-4363-9295-35d6b473981a Element in sequence has 'energy_m3' but the meter's fuel does not support it. 'energy_wh' is supported: value: code: ENERGY_ELEMENT_ENERGY_M3_ON_UNSUPPORTED_FUEL_METER description: Element in sequence has 'energy_m3' but the meter's fuel does not support it. 'energy_wh' is supported request_id: 65e2ea86-470f-4363-9295-35d6b473981a ? Parameter 'interval_start' must not be null. This may be caused by incorrect datetime format, please refer to documentation : value: code: ENERGY_ELEMENT_INTERVAL_START_MISSING description: Parameter 'interval_start' must not be null. This may be caused by incorrect datetime format, please refer to documentation request_id: 65e2ea86-470f-4363-9295-35d6b473981a ? Parameter 'interval_start' must align with given resolution (eg. 'xx:00:00' for hourly, 'xx:00:00' and 'xx:30:00' for 30min). Please refer to documentation for more information : value: code: ENERGY_ELEMENT_INTERVAL_START_DATE_INVALID_FOR_RESOLUTION description: Parameter 'interval_start' must align with given resolution (eg. 'xx:00:00' for hourly, 'xx:00:00' and 'xx:30:00' for 30min). Please refer to documentation for more information request_id: 65e2ea86-470f-4363-9295-35d6b473981a Gap not matching resolution size between 'interval_start' dates have been found.: value: code: GAP_IN_ENERGY_DATE_INTERVAL description: Gap not matching resolution size between 'interval_start' dates have been found. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'interval_start' must be between meter SupplyStartDate and SupplyEndDate dates.: value: code: ENERGY_INTERVAL_START_DATE_IS_OUTSIDE_METER_SUPPLY_DATE_RANGE description: Parameter 'interval_start' must be between meter SupplyStartDate and SupplyEndDate dates. request_id: 65e2ea86-470f-4363-9295-35d6b473981a '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Meter with given id could not be found: value: code: METER_NOT_FOUND description: Meter with given id could not be found request_id: 65e2ea86-470f-4363-9295-35d6b473981a '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Internal server error. If problem remains, please contact support: value: code: INTERNAL_ERROR description: Internal server error. If problem remains, please contact support request_id: 65e2ea86-470f-4363-9295-35d6b473981a delete: tags: - Meter Energy High Resolution summary: Deletes the high resolution (hourly or higher) energy data for a meter operationId: delete-high-resolution-energy-meterid-2 parameters: - name: id in: path description: Meter external reference required: true schema: type: string - name: resolution in: path description: Resolution of the data provided required: true schema: type: string - name: FromDate in: query schema: type: string - name: From in: query schema: type: string - name: ToDate in: query schema: type: string - name: To in: query schema: type: string responses: '204': description: No Content content: application/json: schema: $ref: '#/components/schemas/NoContentResult' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Missing parameters 'from' and 'to'. This may be caused by incorrect date format, please refer to documentation: value: code: DATE_RANGE_MISSING description: Missing parameters 'from' and 'to'. This may be caused by incorrect date format, please refer to documentation request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'id' must not be null or empty: value: code: METER_ID_MISSING description: Parameter 'id' must not be null or empty request_id: 65e2ea86-470f-4363-9295-35d6b473981a Resolution must not be null or empty: value: code: RESOLUTION_MISSING description: Resolution must not be null or empty request_id: 65e2ea86-470f-4363-9295-35d6b473981a From date is missing. This may be caused by incorrect date format, please refer to documentation: value: code: FROM_MISSING description: From date is missing. This may be caused by incorrect date format, please refer to documentation request_id: 65e2ea86-470f-4363-9295-35d6b473981a To date is missing. This may be caused by incorrect date format, please refer to documentation: value: code: TO_MISSING description: To date is missing. This may be caused by incorrect date format, please refer to documentation request_id: 65e2ea86-470f-4363-9295-35d6b473981a Date range is invalid i.e. 'from' date is after 'to' date: value: code: DATE_RANGE_INVALID description: Date range is invalid i.e. 'from' date is after 'to' date request_id: 65e2ea86-470f-4363-9295-35d6b473981a '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Meter with given id could not be found: value: code: METER_NOT_FOUND description: Meter with given id could not be found request_id: 65e2ea86-470f-4363-9295-35d6b473981a '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Internal server error. If problem remains, please contact support: value: code: INTERNAL_ERROR description: Internal server error. If problem remains, please contact support request_id: 65e2ea86-470f-4363-9295-35d6b473981a get: tags: - Meter Energy High Resolution summary: Gets the stored high resolution (hour or higher) energy data for a meter within… operationId: get-high-resolution-energy-meterid parameters: - name: id in: path description: Meter external reference required: true schema: type: string - name: resolution in: path description: Resolution of the data provided required: true schema: type: string - name: FromDate in: query schema: type: string - name: From in: query schema: type: string - name: ToDate in: query schema: type: string - name: To in: query schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/EnergyHighResolutionData' examples: Energy high resolution data: value: - interval_start: '2024-01-01T00:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T01:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T02:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T03:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T04:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T05:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T06:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T07:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T08:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T09:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T10:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T11:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T12:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T13:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T14:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T15:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T16:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T17:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T18:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T19:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T20:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T21:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T22:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-01T23:00:00Z' energy_wh: 1000.0 is_estimated: false - interval_start: '2024-01-02T00:00:00Z' energy_wh: 1000.0 is_estimated: false '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Missing parameters 'from' and 'to'. This may be caused by incorrect date format, please refer to documentation: value: code: DATE_RANGE_MISSING description: Missing parameters 'from' and 'to'. This may be caused by incorrect date format, please refer to documentation request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'id' must not be null or empty: value: code: METER_ID_MISSING description: Parameter 'id' must not be null or empty request_id: 65e2ea86-470f-4363-9295-35d6b473981a Resolution must not be null or empty: value: code: RESOLUTION_MISSING description: Resolution must not be null or empty request_id: 65e2ea86-470f-4363-9295-35d6b473981a 'Invalid resolution. Must be one of: [hour, 30min, 15min, 10min, 6min]': value: code: RESOLUTION_INVALID description: 'Invalid resolution. Must be one of: [hour, 30min, 15min, 10min, 6min]' request_id: 65e2ea86-470f-4363-9295-35d6b473981a From date is missing. This may be caused by incorrect date format, please refer to documentation: value: code: FROM_MISSING description: From date is missing. This may be caused by incorrect date format, please refer to documentation request_id: 65e2ea86-470f-4363-9295-35d6b473981a To date is missing. This may be caused by incorrect date format, please refer to documentation: value: code: TO_MISSING description: To date is missing. This may be caused by incorrect date format, please refer to documentation request_id: 65e2ea86-470f-4363-9295-35d6b473981a Date range is invalid i.e. 'from' date is after 'to' date: value: code: DATE_RANGE_INVALID description: Date range is invalid i.e. 'from' date is after 'to' date request_id: 65e2ea86-470f-4363-9295-35d6b473981a Maximum range between 'from' and 'to' exceeded. Please refer to documentation: value: code: DATE_RANGE_LIMIT_EXCEEDED description: Maximum range between 'from' and 'to' exceeded. Please refer to documentation request_id: 65e2ea86-470f-4363-9295-35d6b473981a '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Meter with given id could not be found: value: code: METER_NOT_FOUND description: Meter with given id could not be found request_id: 65e2ea86-470f-4363-9295-35d6b473981a '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Internal server error. If problem remains, please contact support: value: code: INTERNAL_ERROR description: Internal server error. If problem remains, please contact support request_id: 65e2ea86-470f-4363-9295-35d6b473981a /meters/{id}/energy/{resolution}: delete: tags: - Meter Energy High Resolution summary: Deletes the high resolution (hourly or higher) energy data for a meter operationId: delete-high-resolution-energy-meterid parameters: - name: id in: path description: Meter external reference required: true schema: type: string - name: resolution in: path description: Resolution of the data provided required: true schema: type: string - name: FromDate in: query schema: type: string - name: From in: query schema: type: string - name: ToDate in: query schema: type: string - name: To in: query schema: type: string responses: '204': description: No Content content: application/json: schema: $ref: '#/components/schemas/NoContentResult' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Missing parameters 'from' and 'to'. This may be caused by incorrect date format, please refer to documentation: value: code: DATE_RANGE_MISSING description: Missing parameters 'from' and 'to'. This may be caused by incorrect date format, please refer to documentation request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'id' must not be null or empty: value: code: METER_ID_MISSING description: Parameter 'id' must not be null or empty request_id: 65e2ea86-470f-4363-9295-35d6b473981a Resolution must not be null or empty: value: code: RESOLUTION_MISSING description: Resolution must not be null or empty request_id: 65e2ea86-470f-4363-9295-35d6b473981a From date is missing. This may be caused by incorrect date format, please refer to documentation: value: code: FROM_MISSING description: From date is missing. This may be caused by incorrect date format, please refer to documentation request_id: 65e2ea86-470f-4363-9295-35d6b473981a To date is missing. This may be caused by incorrect date format, please refer to documentation: value: code: TO_MISSING description: To date is missing. This may be caused by incorrect date format, please refer to documentation request_id: 65e2ea86-470f-4363-9295-35d6b473981a Date range is invalid i.e. 'from' date is after 'to' date: value: code: DATE_RANGE_INVALID description: Date range is invalid i.e. 'from' date is after 'to' date request_id: 65e2ea86-470f-4363-9295-35d6b473981a '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Meter with given id could not be found: value: code: METER_NOT_FOUND description: Meter with given id could not be found request_id: 65e2ea86-470f-4363-9295-35d6b473981a '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Internal server error. If problem remains, please contact support: value: code: INTERNAL_ERROR description: Internal server error. If problem remains, please contact support request_id: 65e2ea86-470f-4363-9295-35d6b473981a components: schemas: NoContentResult: type: object properties: statusCode: type: integer format: int32 ErrorDetails: required: - code - description type: object properties: code: minLength: 1 type: string description: minLength: 1 type: string request_id: type: - string - 'null' EnergyHighResolutionData: type: object properties: interval_start: type: - string - 'null' energy_wh: type: - number - 'null' format: float energy_m3: type: - number - 'null' format: float is_estimated: type: boolean x-tagGroups: - name: Users tags: - User - name: Locations tags: - Location - Location profile - Location home profile - Location price formulas - name: Meters tags: - Meter - Meter Energy Day - Meter Energy High Resolution - Meter Energy Reads - Meter Energy Period - Meter Max Demand - Meter Price Formulas - name: Jobs tags: - Jobs - name: Portfolio tags: - Portfolio Accounts - Portfolio Groups - Portfolio Locations - Portfolio Users - name: Client details tags: - Client details