[GET] Get retirement beneficiaries
- hao nguyen
- Siyuan Shu
- Que Nguyen
- allen li
Get all beneficiaries
获取所有受益人
Table of Contents
- 1 Table of Contents
- 2 Changelogs
- 3 The Beneficiary Resource
- 4 API Definition
- 4.1 Request
- 4.1.1 Headers
- 4.1.2 Parameters
- 4.2 Response
- 4.1 Request
- 5 Rate limit
Changelogs
Version | Date | Changes by | Description of change |
V1.0 | Mar 24, 2024 | Que Nguyen |
|
V1.0.1 | Aug 12, 2024 | Que Nguyen |
|
The Beneficiary Resource
Id uuid Beneficiary unique identifier 受益人唯一識別符 |
Name text Beneficiary name. The name is used to appear on the Renewable Energy certificate. 受益人名称。显示在绿证认证上的名字 |
CountryCode text Country Alpha Two Code - ISO 3166 国家两位代码 |
PersonName text Beneficiary Person Name 受益人个人名称 |
PersonalAddress text Beneficiary Person Address 受益人个人地址 |
BuildingName text Beneficiary Building Name 受益人建筑名称 |
BuildingOwnerName text Beneficiary Building Owner Name 受益人建筑业主名称 |
BuildingAddress text Beneficiary Building Address 受益人建筑地址 |
CorporateName text Beneficiary Corporate Name 受益人公司名字 |
CorporateAddress text Beneficiary Corporate Address 受益人公司地址 |
{
"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Name": "Redex Company",
"CountryCode": "SG",
"NameToAppearOnCertificate": "Redex Company",
"BuildingName": null,
"BuildingOwnerName": null,
"BuildingAddress": null,
"CorporateName": null,
"CorporateAddress": null,
"PersonName": "Yen Le Redex",
"PersonalAddress": "Blk 71 Ayer Rajah Crescent #06-15 Singapore 139951"
}API Definition
GEt /public/v2/retirement-applications/beneficiaries
Request
Headers
Content-Type |
|
Authorization |
|
Parameters
Parameters |
|---|
ItemsPerPage - integer The maximum number of inverter brands to return per page. This number can range from 10 to 100 and defaults to 100. 每页最多返回数在 10 - 100 之间，默认为 100。 |
CurrentPage (optional) - integer The page number to retrieve the next set of inverters. The number has to be greater than 1, and will default to 1. 检索下一组逆变器的页码。该数字必须大于 1，并且默认为 1。 |
Example request
curl -X GET https://uat-api.redex.eco/public/v2/retirement-applications/beneficiaries?CurrentPage=1&ItemsPerPage=10 \
-H 'Authorization: Bearer <access_token>'
Response
Response Body |
Data array[object] - objects of Beneficiary Resource A collection of Beneficiary 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 http状态码，如 200，201，404 |
Message text Response message: Success or error message. 返回成功或错误的信息。 |
200 Success
{
"Data": [
{
"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Name": "Redex Company",
"CountryCode": "SG",
"BuildingName": null,
"BuildingOwnerName": null,
"BuildingAddress": null,
"CorporateName": null,
"CorporateAddress": null,
"PersonName": "Yen Le Redex",
"PersonalAddress": "Blk 71 Ayer Rajah Crescent #06-15 Singapore 139951"
}
],
"Errors": null,
"Meta": {
"CurrentPage": 1,
"TotalPage": 1,
"ItemsPerPage": 10,
"TotalItems": 1
},
"StatusCode": 200,
"Message": "Success"
}
401 Unauthorized
403 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-idbusiness account Id.Increment Condition: Any Request.
Rate Limit Details
Rate Limit by Key:
Key: This ensures that rate limits are applied uniquely for each business account id.
Request Limit: Each key is allowed to make up to 60 requests per minute.
Reset Interval: The limit resets every 60 seconds.
Response Headers:
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.