README.md

DBsSA 接口文档 （DBsSA API Document）

---

目录

• 公寓模块（Apartment Module）
  • 公寓相关接口 （Apartment Related Interfaces）
    • 创建公寓楼 （Create Apartment）
    • 查询公寓楼信息（Query Apartment Information）
    • 查询公寓楼列表（Query Apartments）
  • 预订系统相关接口（Reservation Related Interfaces）
    • 查询可预订的公寓列表 (Query Available Apartments)
    • 创建预订订单（Create Reservation Order）

公寓模块（Apartment Module）

公寓相关接口 （Apartment Related Interfaces）

创建公寓楼 （Create Apartment）

• 接口 (Interface)： /apartment
• 请求方法 (Request Method)： POST
• 请求内容 (Request Body)：

{
  "apartmentName": "Atlas",
  "address": "6 Miles Street, Vauxhall, London SW8 1RZ",
  "officialPhone": "+44 204 537 9191",
  "floorNumber": 37,
  "numberOfRooms": 400,
  "numberOfBedrooms": 535,
  "numberOfBathrooms": 570,
  "numberOfPublicRooms": 26,
  "floorSpace": 800,
  "maximumRent": "670",
  "createDate": "2021-04-01",
  "startDate": "2022-01-01"
}

• 响应内容 (Response Body)：

{
  "errorCode": 0,
  "errorMsg": "success",
  "data": {
    "apartmentId": 1
  }
}

查询公寓楼信息（Query Apartment Information）

• 接口 (Interface)： /apartment/{apartmentId}
• 请求方法 (Request Method)： GET
• 请求内容 (Request Body)：
• 响应内容 (Response Body)：

{
  "id": 1,
  "apartmentName": "Atlas",
  "address": "6 Miles Street, Vauxhall, London SW8 1RZ",
  "officialPhone": "+44 204 537 9191",
  "floorNumber": 37,
  "numberOfRooms": 400,
  "numberOfBedrooms": 535,
  "numberOfBathrooms": 570,
  "numberOfPublicRooms": 26,
  "floorSpace": 800,
  "maximumRent": "670",
  "createDate": "2021-04-01",
  "startDate": "2022-01-01"
}

查询公寓楼列表（Query Apartments）

• 接口 (Interface)： /apartments
• 请求方法 (Request Method)： GET
• 请求内容 (Request Body)：
• 响应内容 (Response Body)：

[
  {
    "id": 1,
    "apartmentName": "Atlas",
    "address": "6 Miles Street, Vauxhall, London SW8 1RZ",
    "officialPhone": "+44 204 537 9191",
    "floorNumber": 37,
    "numberOfRooms": 400,
    "numberOfBedrooms": 535,
    "numberOfBathrooms": 570,
    "numberOfPublicRooms": 26,
    "floorSpace": 800,
    "maximumRent": "670",
    "createDate": "2021-04-01",
    "startDate": "2022-01-01"
  },
  {
    "id": 2,
    "apartmentName": "Vega",
    "address": "6 Miles Street, Vauxhall, London SW8 1RZ",
    "officialPhone": "+44 204 537 9191",
    "floorNumber": 37,
    "numberOfRooms": 400,
    "numberOfBedrooms": 535,
    "numberOfBathrooms": 570,
    "numberOfPublicRooms": 26,
    "floorSpace": 800,
    "maximumRent": "670",
    "createDate": "2021-04-01",
    "startDate": "2022-01-01"
  }
]

预订系统相关接口（Reservation Related Interfaces）

查询可预订的公寓列表 (Query Available Apartments)

• 接口 (Interface)： /reservation/apartments
• 请求方法 (Request Method)： GET
• 请求内容 (Request Body)：
• 响应内容 (Response Body)：

[
  {
    "id": 1,
    "apartmentName": "Atlas",
    "address": "6 Miles Street, Vauxhall, London SW8 1RZ",
    "officialPhone": "+44 204 537 9191",
    "floorNumber": 37,
    "numberOfRooms": 400,
    "numberOfBedrooms": 535,
    "numberOfBathrooms": 570,
    "numberOfPublicRooms": 26,
    "floorSpace": 800,
    "maximumRent": "670",
    "createDate": "2021-04-01",
    "startDate": "2022-01-01"
  },
  {
    "id": 2,
    "apartmentName": "Vega",
    "address": "6 Miles Street, Vauxhall, London SW8 1RZ",
    "officialPhone": "+44 204 537 9191",
    "floorNumber": 37,
    "numberOfRooms": 400,
    "numberOfBedrooms": 535,
    "numberOfBathrooms": 570,
    "numberOfPublicRooms": 26,
    "floorSpace": 800,
    "maximumRent": "670",
    "createDate": "2021-04-01",
    "startDate": "2022-01-01"
  }
]

创建预订订单（Create Reservation Order）