Query retirement applications

Changelogs

Version	Date	Changes by	Description of change
v1.0	19 Jul 2024	Tam Tran	Add Table of Contents. Add Changelogs. Add Resource Add Definition

Retirement Application Detail Resource

Id uuid

Retirement Application Unique Identifier

赎回核销申请唯一标识符

ApplicationNumber text

Application Number

申请序列号

Amount decimal

总量

Value Redemption

核销值

DeviceId uuid

设备 Id

Device Unique Id

设备唯一标识符

DeviceName text

设别名称

Device Name

设别名称

BeneficiaryId uuid

受益人唯一标识符

Beneficiary Id

受益人唯一标识符

BeneficiaryName text

受益人名称

Beneficiary Name

受益人名称

Energy text

能源类型

Energy Type

能源类型

CountryCode text

国家代码

Country Alpha 2 Code

国家两位代码

VintageYear number

生效年

Vintage Year

生效年

Status: Value text

状态：值

Value of Status (InProgress, Completed, …)

状态值（处理中，完成, …）

Status: Description text

状态：描述

Description of Status (In-Progress, Completed, ..)

状态描述（处理中，完成, …）

InvoiceNumber text

发票序列号

Invoice Number Unique

发票唯一序列号

Registry: Value text

注册处：值

Value of Registry (IREC, TIGR)

注册处（IREC 或 TIGR）

Registry:Description text

Description of Registry (I-REC, TIGR)

注册处描述

NameToAppearOnCertificate text

Name display on certificate

显示在绿证认证上的名字

CompletedTime datetime

Completed Time

完成时间

DecisionTime datetime

Decision Time

决策时间

CreatedTime datetime

Created Time

创建时间

UpdatedTime datetime

Updated Time

更新时间

BlobContent text

Uri Of Cert Redemption.

核销认证的 Uri

VerificationUrl text

Verification URL

认证 URL

VerificationKey text

Verification Key

认证 Key

{
  "Id": "326be15c-795e-4c33-26f0-08dbf7dca95f",
  "ApplicationNumber": "1000001802142963",
  "Amount": 10,
  "DeviceId": "68c36977-3a6f-4f5f-5b88-08db564c5896",
  "DeviceName": "Hydro small IREC",
  "BeneficiaryId": "68c36977-3a6f-4f5f-5b88-08db564c5896",
  "BeneficiaryName": "Redex Company",
  "Energy": "Hydro",
  "CountryCode": "SG",
  "VintageYear": 2023,
  "Status": {
    "Value": "InProgress",
    "Description": "In-Progress"
  },
  "InvoiceNumber": "INV-012",
  "Reason": "Remption testing",
  "Registry": {
    "Value": "IREC",
    "Description": "I-REC"
  },
  "NameToAppearOnCertificate": "YENLE7",
  "CompletedTime": "2024-07-17T07:57:20.0809934Z",
  "DecisionTime": "2024-07-17T07:57:20.0809926Z",
  "CreatedTime": "2024-07-17T10:43:49.0126791",
  "UpdatedTime": "2024-07-17T10:43:50.0126791",
  "BlobContent": "https://rehash3dev.blob.core.windows.net/files/sample.pdf",
  "VerificationUrl": "",
  "VerificationKey": "",
  "RetiredItems": [
      {
          "CountryCode": "CN",
          "FuelType": "Solar",
          "AssetName": "Grouped_Q_2",
          "DeviceUniqueId": "CN-SOLAR-01012000-0872912616",
          "ProvinceCode": "CN-HN",
          "IsOwnerAsset": true,
          "VintageYear": 2023,
          "RecItemId": "a29e437c-4690-4b89-bb68-08dca61cacb5",
          "RecItemType": "Issued",
          "TradingCount": 0,
          "SerialNumbers": "IREC-GROUES11032-CN-2023-0630-0730",
          "Quantity": 12.432256
      }
  ]
}

API Definition

GET/public/v2/retirement-applications/{guid}

Request

Headers

Content-Type	`application/json`
Authorization	`Bearer {{access_token}}`

Parameters

RetirementApplicationId - uuid

The ID Of Retirement Application

核销绿证申请 ID

Example request

curl -X GET https://uat-api.redex.eco/public/v2/retirement-applications/B04254E4-C5C7-4BC5-8985-08DCA63607A0 \
     -H 'Authorization: Bearer <access_token>'

Response

Response Body

Data object - object of Retirement Application Detail Resource

A collection of Retirement Application Detail Resource

Errors list of error objects

Please see "Getting Started - #Error Object" for more details

请查看 Getting Started - #Error Object 以获得更多信息。

Meta pagination resource

Return Pagination Resource

返回分页信息

StatusCode integer

Http Status codes standard. Example 200, 201, 404.

http状态码，如 200，201，404

Message text

Response message: Success or error message.

返回成功或错误的信息。

200 Success

{
    "Data": {
        "Id": "b04254e4-c5c7-4bc5-8985-08dca63607a0",
        "ApplicationNumber": "1000000635224756",
        "Amount": 12.432256,
        "DeviceId": "00000000-0000-0000-0000-000000000000",
        "DeviceName": "",
        "BeneficiaryId": "20477a72-1c19-4e96-29d2-08dca09cc4eb",
        "BeneficiaryName": "Patez Company",
        "Energy": "",
        "CountryCode": "",
        "VintageYear": 2023,
        "Status": "Completed",
        "StatusDescription": "Completed",
        "InvoiceNumber": "",
        "Reason": "hihi",
        "Registry": "IREC",
        "RegistryDescription": "I-REC",
        "NameToAppearOnCertificate": "Patez Company",
        "CompletedTime": "2024-07-17T07:57:20.0809934Z",
        "DecisionTime": "2024-07-17T07:57:20.0809926Z",
        "CreatedTime": "2024-07-17T07:57:10.957",
        "UpdatedTime": "2024-07-17T07:58:01.653",
        "BlobContent": "https://rehash3dev.blob.core.windows.net/files/sample/sample.pdf",
        "VerificationUrl": null,
        "VerificationKey": null
    },
    "Meta": null,
    "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"
}

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.

Example Response When Rate Limit is Exceeded

HTTP/1.1 429 Too Many Requests
Retry-After: 60
Content-Type: application/json
{
    "Data": null,
    "Errors": null,
    "StatusCode": 429,
    "Message": "Rate limit exceeded",
    "Meta": null
}

[GET] Get retirement application detail

Table of Contents