This API are designed for you to be able to query your grouped device application’s devices and inverters information.
Table of Contents
Changelogs
Version | Date | Changes by | Description of change |
V 1.0.1 |
| Que Nguyen |
|
Release status
Environment | Status | Released Date | Version |
DEV | RELEASED | Mar 25, 2024 | V1.0.1 |
UAT | NOT RELEASED | ||
PROD | NOT RELEASED |
The Device - Inverter Resource
The primary resource that you will be interacting with when querying the Grouped Device’s information
Id uuid A Device unique identifier |
InstallationName text The installation name of a device represents the project device. This name must match the value stated on the Owner Declaration Form in the appendix table. |
Address text Device’s physical address. |
PostalCode text Device’s postal code. |
Latitude decimal(2,6) The co-ordinates must demonstrate the location of the device or device. These co-ordinates must belong in the country/province identified previously. |
Longitude decimal(3,6) The co-ordinates must demonstrate the location of the device or device. These co-ordinates must belong in the country/province identified previously. |
GridConnectionDate text - format The date when the device connected to the electrical grid and was commissioned. The grid connection date must not be in the future. |
OwnersDeclarationStartDate text - format Owner's Declaration Start Date: The date when permission begins for requesting issuance on behalf of a device owner. This date must be on or before the issuance request date. Datetime in format: |
OwnersDeclarationEndDate (optional) text - format Owner's Declaration End Date Datetime in format: |
Domestic boolean Indicates whether the installation is on a domestic property or not. |
FeedInTariff boolean Feed In Tariff |
DeclarationFormFileId uuid Declaration form file’s file ID retrieved using the API. |
PercentageRenewable decimal(3,6) Device’s Percentage Renewable Must be in range 0 <= value <= 100 |
Timezone text Its Grouped Device Time zone information. Sample: UTC+08:00 |
CreatedTime datetime The time when application created Datetime time zone: UTC More details |
Inverters array of objects { "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "RemoteInvId": "RM1000020898439275847-T", "BrandCode": "HW21", "OtherBrandName": "", "ElectronicSerialNumber": "HW8984392758437-T", "InstalledCapacity": 9.9, "CreatedTime": "2024-06-05T03:18:34.469Z" } |
Inverters[m].Id uuid Inverter Unique Id |
Inverters[m].RemoteInvId text - max length (100) Remote Inverter Id |
Inverters[m].ElectronicSerialNumber text - max length (255) Inverter Electronic Serial Number |
Inverters[m].BrandCode (required) text - max length (20) Inverter Brand Code. Reference codes |
Inverters[m].OtherBrandName text - max length (255) Inverter Other Brand Name |
Inverters[m].InstalledCapacity decimal(12,3) Inverter Installed Capacity in kW. Maximum capacity 1000 kW (1MW) |
CreatedTime datetime The time when application created Datetime time zone: UTC More details |
{ "Id": "347847fa-68c0-4418-9119-08dc3993455a", "InstallationName": "Kong Meng San Phor Kark See Monastery", "Address": "88 Bright Hill Road", "PostalCode": "431231", "Longitude": 1.361516, "Latitude": 1.361516, "GridConnectionDate": "2022-05-15 00:00:00", "OwnersDeclarationStartDate": "2022-05-15 00:00:00", "OwnersDeclarationEndDate": "2022-10-15 00:00:00", "Domestic": false, "FeedInTariff": false, "DeclarationForm": "a70fa68f-58a9-46d1-a338-f2e023af3194", "PercentageRenewable": 45.55, "Timezone": "UTC+08:00", "CreatedTime": "2024-06-05T03:18:34.469Z", "Inverters": [ { "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "RemoteInvId": "RM1000020898439275847-T", "BrandCode": "HW21", "OtherBrandName": "", "ElectronicSerialNumber": "HW8984392758437-T", "InstalledCapacity": 9.9, "CreatedTime": "2024-06-05T03:18:34.469Z" } ] }
API Definitions
GET /public/v2/device-applications/{deviceApplicationId}/devices
Example: /public/v2/device-applications/347847fa-68c0-4418-9119-08dc3993455a/devices
Request
Headers
Authorization text Authorization Bearer access token Ex: |
Path
deviceApplicationId uuid A Device application unique identifier |
Query Parameters
CurrentPage (optional) integer The page number to retrieve the next set of inverters. The number has to be greater than 1 and will default to 1. |
ItemsPerPage (optional) integer The maximum number of devices to return per page. This number can range from 10 to 100 and defaults to 100. |
Example request
curl -X 'GET' \ 'https://uat-api.redex.eco/public/v2/device-applications/347847fa-68c0-4418-9119-08dc3993455a/devices?CurrentPage=1&ItemsPerPage=10' \ -H 'Authorization: Bearer <access_token>' -H 'accept: application/json'
Response
Response Body |
Data list of grouped devices A collection of Device Inverter Resource |
Errors list of error objects Please see "Getting Started - #Error Object" for more details 请查看Getting Started - #Error Object以获得更多信息。 |
Meta pagination resource Return Pagination Resource 返回分页信息 |
StatusCode integer Http Status codes standard. Example http状态码,如200,201,404 |
Message text Response message: Success or error message. 返回成功或错误的信息。 |
Example Response
200 OK
{ "Data": [ { "Id": "347847fa-68c0-4418-9119-08dc3993455a", "InstallationName": "Kong Meng San Phor Kark See Monastery", "Address": "88 Bright Hill Road", "PostalCode": "431231", "Longitude": 1.361516, "Latitude": 1.361516, "GridConnectionDate": "2022-05-15 00:00:00", "OwnersDeclarationStartDate": "2022-05-15 00:00:00", "OwnersDeclarationEndDate": "2022-10-15 00:00:00", "Domestic": false, "FeedInTariff": false, "DeclarationForm": "a70fa68f-58a9-46d1-a338-f2e023af3194", "PercentageRenewable": 45.55, "Timezone": "UTC+08:00", "CreatedTime": "2024-06-05T03:18:34.469Z", "Inverters": [ { "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "RemoteInvId": "RM1000020898439275847-T", "BrandCode": "HW21", "OtherBrandName": "", "ElectronicSerialNumber": "HW8984392758437-T", "InstalledCapacity": 9.9, "CreatedTime": "2024-06-05T03:18:34.469Z" } ] } ], "Meta": { "CurrentPage": 1, "TotalPage": 1, "TotalItems": 1, "ItemsPerPage": 100 }, "Errors": null, "StatusCode": 200, "Message": "Success" }
404 Not Found
{ "Data": null, "Meta": null, "Errors": null, "StatusCode": 404, "Message": "The Device Application ID: bfa462c1-7e98-4f7b-8521-08dc7920a5f2 does not exist." }