Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Table of Contents

Changelogs

Version

Date

Changes by

Description of change

V1.0

Mar 29, 2024

Que Nguyen

  • Add Table of Contents.

  • Add Changelogs.

V1.0.1

Apr 11, 2024

Que Nguyen

  • Add Release Status

Release status

Environment

Status

Released Date

Version

DEV

NOT RELEASED

N/A

N/A

UAT

NOT RELEASED

N/A

N/A

PROD

NOT RELEASED

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

Content-Type

application/json

Authorization

Bearer {{token}}

Parameters

ItemsPerPage

  • numeric

  • query

The total items that return in the response

Page

  • numeric

  • query

Request field for pagination. The Page that you wish to view

Registries

  • array[string]

  • query

Filter the items by Registry

  • IREC

  • TIGR

Returns

Get REC Inventory

Response Header

Content-Type

application/json

Response Body

Field

Type

Description

Id

uuid

REC Unique Identifier

AssetId

uuid

Device Unique Identifier

AssetName

string

Name Of Device

Registry:Value

string

Value of Registry (IREC, TIGR)

Registry:Description

string

Description of Registry (I-REC, TIGR)

SerialNumber

string

REC Serial Number

Serial number is combination of RecPrefix

From

decimal(18,6)

From REC Index

To

decimal(18,6)

To REC Index

Total

decimal(18,6)

REC Quantity

Retired

decimal(18,6)

Retired REC Quantity: number of RECs retired

OnSale

decimal(18,6)

On Sale: number of RECs on sale

OnRetirement

decimal(18,6)

On Retirement: number of RECs on retirement

OnDelisting

decimal(18,6)

On Delisting: number of RECs on delisting

Delisted

decimal(18,6)

Delisted: number of RECs delisted

OnAuction

decimal(18,6)

On Auction: number of RECs on auction

Available

decimal(18,6)

Available RECs: number of available RECs

Available numbers = Total - OnSale - OnRetirement - On Retired - OnDelist - Delisted - OnAuction

Balance

decimal(18,6)

Balance of REC items:

Balance = Available + On Sale + On Retirement + On Exporting + On Auction

VintageFrom

Datetime

Date Time UTC

VintageTo

Datetime

Date Time UTC

CountryCode

string

Country Code. Ex: SG

FuelType

string

Fuel Type

EnergyValue

string

Energy Type

VintageYear

int

Vintage Year

TradingCount

int

Trading Count

RecItemType

Fuel Name (Marine Wave…)

Energy

Energy Value (Marine Wave…)

CommissionDate

Date Time UTC

Request

GET/public/v2/inventories/recs

Parameter

?Page=5&ItemsPerPage=10&RegistryName=IREC

Response

200 Success

{
  "Data": [
    {
      "RegistryId": "GFNIES10001",
      "Retired": 0,
      "Id": "326be15c-795e-4c33-26f0-08dbf7dca95f",
      "AssetId": "f26be15c-795e-4c33-26f0-08dbf7dca95f",
      "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,
      "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",
      "Registry": {
        "Value": "IREC",
        "Description": "I-REC"
      }
    }
  ],
  "Meta": {
    "CurrentPage": 5,
    "TotalPage": 7,
    "ItemsPerPage": 1,
    "TotalItems": 64,
  },
  "Errors": null,
  "StatusCode": 200,
  "Message": "Success"
}

404 Not Found

{
  "Data": null,
  "Errors": null,
  "Meta": null,
  "StatusCode": 404,
  "Message": "Not found"
}

401 Unauthorized

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

403 Forbidden

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