Versions Compared

Old Version 7

changes.mady.by.user Que Nguyen

Saved on

compared with

New Version 8

changes.mady.by.user Que Nguyen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Table of Contents
stylenone

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

Status
colourBlue
titleNOT RELEASED

N/A

N/A

UAT

Status
colourBlue
titleNOT RELEASED

N/A

N/A

PROD

Status
colourBlue
titleNOT 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}}

Query Parameters

ItemsPerPage

  • numeric

  • query

The total items that return in the response

CurrentPage

  • numeric

  • query

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

Registries

  • array[string]

  • query

Filter the items by Registry

  • IREC

  • TIGR

DeviceIdDeviceIds

  • array[uuid]

  • string(36)

Device unique identifier

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

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

OnExporting

decimal(18,6)

On Exporting: number of RECs on exporting

Exported

decimal(18,6)

Exported: number of RECs Exported

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 OnExporting - Delisted Exported - OnAuction

Balance

decimal(18,6)

Balance of REC items:

Balance = Available + On Sale + On Retirement + On Exporting OnExporting + 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

  • enum

  • string

(Issued, Imported)

Request

Status
colourGreen
titleGET
/public/v2/inventories/recs

Parameter

Code Block
languagejson
?Page=5&ItemsPerPage=10&RegistryName=IREC

Response

Info

200 Success

Code Block
languagejson
{
  "Data": [
    {
      "Id": "326be15c-795e-4c33-26f0-08dbf7dca95f",
      "DeviceId": "f26be15c-795e-4c33-26f0-08dbf7dca95f",
      "DeviceName": "Sentosa Fun Pass Singapore",
      "DeviceUniqueId": "SG-SOLAR-11012021-2540515487",
      "RegistryId": "GFNIES10001",
      "SerialNumber": "IREC-GFNIES10001-SG-2021-1106-1110-1767.250000 to 1768.249999",
      "Total": 1,
      "Balance": 1,
      "Available": 1,
      "OnSale": 0,
      "OnRetirement": 0,
      "OnExporting": 0,
      "OnAuction": 0,
      "Retired": 0,
      "Exported": 0,
      "VintageFrom": "2021-11-06T00:00:00",
      "VintageTo": "2021-11-10T00:00:00",
      "CountryCode": "SG",
      "FuelType": "Solar",
      "EnergyValue": "Solar",
      "VintageYear": 2021,
      "TradingCount": 1,
      "RecItemType": "Issued",
      "TickerId": "N/A",
      "Registry": {
        "Value": "IREC",
        "Description": "I-REC"
      }
    }
  ],
  "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
languagejson
{
  "Data": null,
  "Errors": null,
  "Meta": null,
  "StatusCode": 401,
  "Message": "Unauthorized"
}

Warning

403 Forbidden

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