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. 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. These co-ordinates must belong in the country/province identified previously.

GridConnectionDate text - format YYYY-MM-DD

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 YYYY-MM-DD

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: YYYY-MM-DD

OwnersDeclarationEndDate (optional) text - format YYYY-MM-DD

Owner's Declaration End Date

Datetime in format: YYYY-MM-DD

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": 1,
  "RemoteInvId": "RM1000020898439275847-T",
  "BrandCode": "HW21",
  "OtherBrandName": "",
  "ElectronicSerialNumber": "HW8984392758437-T",
  "InstalledCapacity": 9.9,
  "CreatedTime": "2024-06-05T03:18:34.469Z"
}

Inverters[m].Id numeric - bigint

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 text - max length (20)

Inverter Brand Code. Reference codes

[GET] Query Inverter Brands

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

Authorization text

Authorization Bearer access token

Ex: Bearer {{access_token}}

deviceApplicationId uuid

A Device application unique identifier

CurrentPage (optional) integer

The page number to retrieve the next set of grouped device’s devices. The number has to be greater than 1 and will default to 1.

ItemsPerPage (optional) integer

The maximum number of grouped device’s devices to return per page. This number can range from 10 to 100 and defaults to 100.

Response Body

Data list of grouped device’s 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 200, 201, 404.

http状态码，如200，201，404

Message text

Response message: Success or error message.

返回成功或错误的信息。