Skip to main content

Area API

The Area API provides ways for the App Users to get the information about centres and districts.

Endpoints​

# Endpoints
GET
/web/areas/{centre}/districts
# 獲取當前用戶中心的區域
GET
/web/areas/out-to
# 獲取可以退會到的區域

Get centre districts​

獲取當前用戶中心的區域

Request​

GET /web/areas/{centre}/districts

Response (DistrictResDTO)​

{
  "success": true,
  "message": "",
  "data": [
    {
      "id": "052fd04d-135b-11ef-b225-7085c2d96f0d",
      "name": "中西區"
    },
    {
      "id": "052fd04d-135b-11ef-b225-7085c2d96f0d",
      "name": "中西區"
    },
    {
      "id": "052fd04d-135b-11ef-b225-7085c2d96f0d",
      "name": "中西區"
    }
  ]
}

Out to districts​

獲取可以退會到的區域

Request​

GET /web/areas/out-to

Response (CentreDistrictResDTO)​

{
  "success": true,
  "message": "",
  "data": [
    [
      {
        "centreEnum": "NLPRA",
        "centreName": "新生精神康復會",
        "districts": [
          {
            "id": "81f6abdc-2930-11ef-b50f-4a12d8c2d6fc",
            "name": "油尖旺"
          },
          {
            "id": "81f6ac18-2930-11ef-b50f-4a12d8c2d6fc",
            "name": "深水埗"
          }
        ]
      },
      {
        "centreEnum": "SHARE",
        "centreName": "其他",
        "districts": [
          {
            "id": "81f6a9e8-2930-11ef-b50f-4a12d8c2d6fc",
            "name": "中西區"
          },
          {
            "id": "81f6aaa6-2930-11ef-b50f-4a12d8c2d6fc",
            "name": "灣仔"
          }
        ]
      }
    ]
  ]
}

Resources​

DistrictResDTO​

properties
  • id
    string
    required
  • name
    string
    required

CentreDistrictResDTO​

properties
  • centreEnum
    string
    required
    CentreEnum
  • centreName
    string
    required
    中心名称
  • id
    String
    required
    區域ID
  • name
    String
    required
    區域名稱