Changelogs

Version	Date	Changes by	Description of change
V1.0	Mar 9, 2024	Que Nguyen	Added Table of Contents. Added Changelogs.
V1.0.1	Apr 10, 2024	Que Nguyen	Added Release Note.
V1.0.2	Apr 16, 2024	Que Nguyen	Update time zone definition for: `ApprovedTime` `CreatedTime` `UpdatedTime`
V1.0.3	May 30, 2024	Que Nguyen	Added Rate Limit Description

Release status

Environment	Status	Released Date	Version
DEV	Released	Mar 25, 2024	V1.0.2
UAT	Released	Mar 25, 2024	V1.0.1
PROD	Released	Mar 25, 2024	V1.0.1

API Definitions

Query Device Application by Application Id

Resource information
Response format(s)	JSON
Requires authentication?	Yes using Access token
Request Header
Name	Value
`Authorization`	`Bearer {{access_token}}`
Parameters
`deviceApplicationId`	`required` `uuid`	Device application unique Identifier
Returns
Returns Data Boolean

Response Header
`Content-Type`	`application/json`
Response Body
Field	Type	Description
`Id`	`uuid` `required`	Application unique identifier 申请id
`DeviceName`	`string` `required`	Device name 设备名称
`DeviceId`	`uuid` `nullable`	Device unique identifier. After Registry approve the application, device Id will be created and use to issue REC. 设备标识符，在注册处通过申请后，device Id会被用来发行绿证
`DeviceFuel`	`string` `nullable`	Device fuel code 设备燃料代码
`DeviceTechnology`	`string` `nullable`	Device technology code 设备技术代码
`Capacity`	`number` `required`	Device capacity or Max capacity if this device is digital device in MW. Please see digital device for more detail 设备容量或最大容量，如果该设备是数字设备，以兆瓦为单位。请参阅数字设备了解更多详细信息
`OriginalCapacity`	`number` `required`	Device original capacity in MW 设备原始容量
`RegistryId`	`string` `nullable`	Registry unique identifier, created after submitting the application to Registry for approval. 注册中心唯一标识符，在向注册中心提交申请以获得批准后创建。
`CommissionDate`	`datetime` `required`	Date of device commissioning 设备调试日期
`RequiredEffectiveRegistrationDate`	`datetime` `required`	Effective registration date (must be on or after the commission date) 设备产生电量的日期（必须在联网日期之后）
`FeedInTariff`	`boolean`	True if device is supported 是否有上网电价补贴
`ConnectedToGrid`	`boolean`	True if device is connected to Power Grid 设备是否联网
`PercentageRenewable`	`number`	Renewable Percentage Example: 0.08 equals to 8% 可再生能源百分比
`OtherLabelingScheme`	`array[string]` `nullable`	I- REC Other Labeling Scheme’s codes I-REC 其他标签计划的值
`Address`	`string` `required`	Installation address location 设备安装地址
`CountryCode`	`string` `required`	Country alpha 2 code 国家代码
`Latitude`	`number` `required`	Device’s coordinates - latitude 经度
`Longitude`	`number` `required`	Device’s coordinates - longitude 纬度
`PostCode`	`string` `nullable`	Installation Postal Code 邮编
`Province`	`string` `nullable`	Installation Province 省份
`RemarkContent`	`array[string]` `nullable`	Remark contents: remarks list 备注，列表格式
`ApprovedTime`	`datetime` `nullable`	The time when application approved by Issuer Datetime time zone: UTC More details 申请被接受时间
`CreatedTime`	`datetime` `required`	The time when application created Datetime time zone: UTC More details 申请创建时间
`UpdatedTime`	`datetime` `required`	The time when application last updated Datetime time zone: UTC More details 上次申请更新时间
`Status:Value`	`string` `required`	Application Status value 申请状态 `InProgress` 进行中 `Unverified` 未验证 `Approved` 已批准 `Declined` 已拒绝
`Status:Description`	`string` `required`	Application Status description 申请状态描述 `In Progress` 进行中 `Unverified` 未验证 `Approved` 已批准 `Declined` 已拒绝
`Registry:Value`	`string` `required`	Registry data value 注册处 IREC TIGR
`Registry:Description`	`string` `required`	Registry data description 注册处描述 I-REC TIGR
`DeviceType:Value`	`string` `required`	Device type data value 设备类型
`DeviceType:Description`	`string` `required`	Device type description 设备类型描述
`Notes`	`string` `nullable`	Additional notes for REDEX verifier and Issuer REDEX验证者和发行者的附加说明

Request

GET /public/v2/device-applications/{deviceApplicationId}

Example: /public/v2/device-applications/347847fa-68c0-4418-9119-08dc3993455a

Response

200 Success

{
  "Data": {
    "Id": "347847fa-68c0-4418-9119-08dc3993455a",
    "DeviceName": "Kong Meng San Phor Kark See Monastery",
    "DeviceId": "94bbbb1f-74c7-468e-4234-08db86911c14",
    "DeviceFuel": "ES100",
    "DeviceTechnology": "TC160",
    "Capacity": 1,
    "OriginalCapacity": 0.0106,
    "RegistryId": "DEV0ES10019",
    "CommissionDate": "2017-02-13T01:00:00",
    "RequiredEffectiveRegistrationDate": "2017-02-13T01:00:00",
    "FeedInTariff": false,
    "ConnectedToGrid": false,
    "PercentageRenewable": null,
    "OtherLabelingScheme": [
      "T-RECs-R"
    ],
    "Address": "27 Wilby Road #B1-00",
    "CountryCode": "SG",
    "Latitude": 1.331817,
    "Longitude": 103.873887,
    "PostCode": "348703",
    "Province": "Singapore",
    "RemarkContent": [],
    "ApprovedTime": "2017-02-13T01:00:00Z",
    "CreatedTime": "2017-02-13T01:00:00Z",
    "UpdatedTime": "2017-02-13T01:00:00Z",
    "DeviceType": {
      "Value": "Normal",
      "Description": "Normal"
    },
    "Status": {
      "Value": "Approved",
      "Description": "Approved"
    },
    "Registry": {
      "Value": "IREC",
      "Description": "I-REC"
    },
    "Notes": ""
  },
  "Errors": null,
  "Meta": null,
  "StatusCode": 200,
  "Message": "Success"
}

401 Unauthorized

{
  "Data": null,
  "Errors": null,
  "Meta": null,
  "StatusCode": 401,
  "Message": "Unauthorized"
}

403 Forbidden

{
  "Data": null,
  "Errors": null,
  "Meta": null,
  "StatusCode": 403,
  "Message": "Forbidden"
}

Rate limit

Rate Limit Algorithm: Fixed Window

In fixed window rate limiting, a fixed time window (e.g., one minute, one hour) is used to track the number of requests or actions allowed within that window. Requests exceeding the limit are either rejected or throttled until the window resets.

Rate Limiting Overview

Our API employs rate limiting to ensure fair usage and protect the performance and availability of the service. Combination of Global Policy and Operation Policy

Global Policy

Rate Limit: 3000 requests per 5 minute(s)
Renewal Period: 300 second(s)
Key: IP Address
Increment Condition: Any Request

Operation Policy

Rate Limit: 60 requests per 1 minute(s)
Renewal Period: 60 second(s)
Key: accound-id business account Id.
Increment Condition: Any Request

Rate Limit Details

Rate Limit by Key:
1. Key: This ensures that rate limits are applied uniquely for each business account id.
2. Request Limit: Each key is allowed to make up to 60 requests per minute.
3. Reset Interval: The limit resets every 60 seconds.
Response Headers:
1. Retry-After: Sent when the rate limit is exceeded, indicating how long to wait before making another request.

Exceeding the Rate Limit

When the rate limit is exceeded, the API will return a 429 Too Many Requests status code. The response will include a Retry-After header specifying the number of seconds to wait before making a new request.

PUBLIC API Documentation

[GET] Query Device Application by Application Id

Table of Contents