Table of Contents
Table of Contents | ||
---|---|---|
|
Changelogs
Version | Date | Changes by | Description of change |
V1.0 | Mar 29, 2024 | Que Nguyen |
|
V1.0.1 | Apr 11, 2024 | Que Nguyen |
|
Release status
Environment | Status | Released Date | Version | ||||||
DEV |
| N/A | N/A | ||||||
UAT |
| N/A | N/A | ||||||
PROD |
| N/A | N/A |
API Definition
Query REC Inventory
Resource information | ||
---|---|---|
Response format(s) | JSON | |
Requires authentication? | Yes using API key | |
Request Header | ||
Name | Value | |
|
| |
|
| |
Parameters | ||
|
| The total items that return in the response |
|
| Request field for pagination. The Page that you wish to view |
|
| Filter the items by Registry
|
Returns | ||
Get REC Inventory |
Response Header | ||
---|---|---|
|
| |
Response Body | ||
Field | Type | Description |
|
| REC Unique Identifier |
|
| Device Unique Identifier |
|
| Name Of Device |
|
| Name of Registry (I-REC, TIGR) |
|
| Owner Name |
|
| REC Serial Number |
|
| From REC Index |
|
| To REC Index |
|
| REC Quantity |
|
| Retired REC Quantity |
|
| On Sale |
|
| OnBlock |
|
| Available RECs |
|
| On Retirement |
|
| On Delisting |
|
| Delisted |
|
| On Auction |
|
| Date Time UTC |
|
| Date Time UTC |
|
| Country Code. Ex: SG |
|
| Fuel Type |
|
| Energy Type |
|
| Vintage Year |
|
| Balance |
|
| Trading Count |
| Fuel Name (Marine Wave…) | |
| Energy Value (Marine Wave…) | |
| Date Time UTC | |
|
| |
|
Request
Status | ||||
---|---|---|---|---|
|
/public/v2/inventories/recs
Parameter
Code Block | ||
---|---|---|
| ||
?Page=5&ItemsPerPage=10&RegistryName=IREC |
Response
Info |
---|
200 Success |
Code Block | ||
---|---|---|
| ||
{ "Data": [ { "RegistryId": "GFNIES10001", "Retired": 0, "Id": "326be15c-795e-4c33-26f0-08dbf7dca95f", "AssetId": null, "RegistryName": "IREC", "OwnerName": "Nam Song Tien Company", "AssetName": "Sentosa Fun Pass Singapore", "SerialNumber": "IREC-GFNIES10001-SG-2021-1106-1110-1767.250000 to 1768.249999", "From": 1767.25, "To": 1768.249999, "Total": 1, "OnSale": 0, "OnBlock": 0, "Available": 1, "OnRetirement": 0, "OnDelisting": 0, "Delisted": 0, "OnAuction": 0, "CountryCode": "SG", "FuelType": "Solar", "EnergyValue": "Solar", "VintageYear": 2021, "Balance": 1, "TradingCount": 1, "RecItemType": "Issued", "DeviceUniqueId": "SG-SOLAR-11012021-2540515487", "IsOwnerAsset": false, "ProvinceCode": null, "ProvinceName": null, "TickerId": "N/A", "VintageFrom": "2021-11-06T00:00:00", "VintageTo": "2021-11-10T00:00:00", } ], "Meta": { "CurrentPage": 5, "TotalPage": 7, "ItemsPerPage": 1, "TotalItems": 64, }, "Errors": null, "StatusCode": 200, "Message": "Success" } |
Warning |
---|
404 Not Found |
Code Block |
---|
{ "Data": null, "Errors": null, "Meta": null, "StatusCode": 404, "Message": "Not found" } |
Warning |
---|
401 Unauthorized |
Code Block | ||
---|---|---|
| ||
{ "Data": null, "Errors": null, "Meta": null, "StatusCode": 401, "Message": "Unauthorized" } |
Warning |
---|
403 Forbidden |
Code Block | ||
---|---|---|
| ||
{ "Data": null, "Errors": null, "Meta": null, "StatusCode": 403, "Message": "Forbidden" } |