Get all beneficiaries types

获取所有受益人类型

Changelogs

Version	Date	Changes by	Description of change
V1.0	Mar 29, 2024	Que Nguyen	Add Table of Contents. Add Changelogs.

API Definition

GEt /public/v2/retirement-applications/beneficiaries/types

Request

Headers

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

Example request

curl -X GET https://uat-api.redex.eco/public/v2/retirement-applications/beneficiaries/types \
     -H 'Authorization: Bearer <access_token>'

Response

Response Body

Data array[object] - objects of Beneficiary Type Resource

A collection of Beneficiary Type Resource

Data[n].Value text

Beneficiary type’s value unique identifier

值唯一标识符

Data[n].Name text

Beneficiary type’s name

名称类型

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": [
    {
      "Value": "Corporate",
      "Name": "Corporate"
    },
    {
      "Value": "Building",
      "Name": "Building"
    },
    {
      "Value": "Personal",
      "Name": "Personal"
    }
  ],
  "Errors": null,
  "Meta": null,
  "StatusCode": 200,
  "Message": "Success"
}

400 Bad Request

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

401 Unauthorized

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

403 Forbidden

{
  "Data": null
  "StatusCode": 403,
  "Errors": null,
  "Meta": null,
  "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
}

PUBLIC API Documentation

[GET] Get beneficiary's types

Table of Contents