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 5 Next »

Get all rec registration

Resource information

Response format(s)

JSON

Requires authentication?

Yes using API key

Request Header

Name

Value

Content-Type

application/json

Authorization

{{token}}

Parameters

Registries

  • array[string]

  • query

Filter the items by Registry

  • IREC

  • TIGR

Status

  • array[string]

  • query

Filter the item by Status

  • Draft

  • InProgress

  • Approved

  • Rejected

CountryCodes

  • array[string]

  • query

Filter the items by Countries' codes

The codes are from ISO 3166-1 alpha-2 (Two letters country code)

Energies

  • array[string]

  • query

Filter the items by aggregated fuel types without technology (called as energy), used to produce electricity.

  • Biomass

  • Geothermal

  • Hydro

  • Solar

  • Wind

Search

  • string

  • query

Enter search data that can be used to search on each items. You can search by:

  • Device Name

  • Energy

  • Application ID

CurrentPage

  • numeric

  • query

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

ItemsPerPage

  • numeric

  • query

The total items that return in the response

OrderBy

  • string

  • query

Sorting field, Default sorting is get all items sort by CreatedTime Desc

Values:

  • CreatedTime

  • To Be Updated

IsDescending

  • boolean

  • query

Used in OrderBy

default: false

Returns

Returns all rec registration

Response:

Response Header

Content-Type

application/json

Response Body

Field

Type

Description

Id

uuid

REC Application Unique Identifier

ApplicationNumber

string

REC Application Unique number

DeviceName

string

Name Of Device

FuelType

string

Fuel Type (Marine Wave…)

CountryCode

string

Country Alpha Two Code

Registry

string

Registry Name (IREC, TIGR)

RegistryDescription

string

Registry Value (I-REC, TIGR)

Quantity

decimal(18,6)

Rec registration quantity (1000.000000)

Status

string

Application current status

  • Draft

  • InProgress

  • Approved

  • Rejected

StatusDescription

string

VintageFrom

Datetime

Date time utc format

VintageTo

Datetime

Date time utc format

CurrentPage

int

 

TotalPage

int

 

TotalRow

int

 

ItemsPerPage

int

Request

GET /public/v2/rec-applications

?Registries=IREC&CountryCodes=SG&CountryCodes=AX&Energies=Marine Wave&Status=Draft

Response

200 Success

{
  "Data": [
    {
      "Id": "cd19a009-bf48-49ab-a795-08db82a34d20",
      "ApplicationNumber": "1000001221242402",
      "DeviceName": "Kong Meng San Phor Kark See Monastery",
      "FuelType": "Marine Wave",
      "CountryCode": "SG",
      "Registry": "IREC",
      "RegistryDescription": "I-REC",
      "Quantity": 1000.0111,
      "Status": "Draft",
      "StatusDescription": "Draft",
      "VintageFrom": "2023-01-01T00:00:00",
      "VintageTo": "2023-05-31T00:00:00"
    }
  ],
  "Meta": {
    "CurrentPage": 1,
    "TotalPage": 1,
    "ItemsPerPage": 10,
    "TotalItems": 1
  },
  "Errors": null,
  "StatusCode": 200,
  "Message": "Success"
} 

400 Bad Request

{
  "Data": null,
  "Errors": null,
  "Meta": null,
  "StatusCode": 400,
  "Message": "Bad Request"
}

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