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 areas districts centre

This endpoint gets a list of districts under the specific centre.

Request

GET /app/areas/all

Response (AreaDistrictDTO)

{
"success": true,
"message": "",
"data": [
{
"areaId": "b447f26c-1909-11ef-8624-4a12d8c2d6fd",
"areaDescription": "港島",
"districtSimpleDTOList": [
{
"districtId": "b44862b0-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "南區",
"centre": "其他"
},
{
"districtId": "b448603a-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "中西區",
"centre": "其他"
},
{
"districtId": "b448615c-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "灣仔",
"centre": "其他"
},
{
"districtId": "b4486238-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "東區",
"centre": "其他"
}
]
},
{
"areaId": "b447f3f2-1909-11ef-8624-4a12d8c2d6fd",
"areaDescription": "九龍",
"districtSimpleDTOList": [
{
"districtId": "b44863fa-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "九龍城",
"centre": "香港心理衞生會"
},
{
"districtId": "b448638c-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "黃大仙",
"centre": "香港心理衞生會"
},
{
"districtId": "b448647c-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "油尖旺",
"centre": "新生精神康復會"
},
{
"districtId": "b4486328-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "觀塘",
"centre": "香港心理衞生會"
},
{
"districtId": "b44864ea-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "深水埗",
"centre": "新生精神康復會"
}
]
},
{
"areaId": "b447f7d0-1909-11ef-8624-4a12d8c2d6fd",
"areaDescription": "新界",
"districtSimpleDTOList": [
{
"districtId": "b448683c-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "屯門",
"centre": "新生精神康復會"
},
{
"districtId": "b4486544-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "北區",
"centre": "香港心理衞生會"
},
{
"districtId": "b44866c0-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "西貢",
"centre": "香港心理衞生會"
},
{
"districtId": "b448677e-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "葵青",
"centre": "新生精神康復會"
},
{
"districtId": "b4486666-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "馬鞍山",
"centre": "香港心理衞生會"
},
{
"districtId": "b4486904-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "天水圍",
"centre": "新生精神康復會"
},
{
"districtId": "b44867e2-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "荃灣",
"centre": "新生精神康復會"
},
{
"districtId": "b44868a0-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "元朗",
"centre": "新生精神康復會"
},
{
"districtId": "b4486602-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "沙田",
"centre": "香港心理衞生會"
},
{
"districtId": "b4486724-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "將軍澳",
"centre": "香港心理衞生會"
},
{
"districtId": "b448659e-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "大埔",
"centre": "香港心理衞生會"
}
]
},
{
"areaId": "b447f87a-1909-11ef-8624-4a12d8c2d6fd",
"areaDescription": "離島",
"districtSimpleDTOList": [
{
"districtId": "b44869b8-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "其他",
"centre": "其他"
},
{
"districtId": "b448695e-1909-11ef-8624-4a12d8c2d6fd",
"districtDescription": "東涌",
"centre": "新生精神康復會"
}
]
}
]
}


Resources

AreaDistrictDTO

properties
  • areaId
    string
    required
    area id
  • areaDescription
    string
    required
    area name
  • districtSimpleDTOList
    list
    required
    district and centre info list
  • districtId
    String
    required
    district id
  • districtDescription
    String
    required
    district name
  • centre
    String
    required
    centre name