File: /var/www/doco/keytest/wp-content/themes/ormedia/API.md
# KeyLab_api
>1. [Login](#Login "Login")
>1. [Data](#Data "Data")
## Login
### 请求地址
/api/login
### 请求类型
POST
### 请求参数
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
| --- | :---: | :---: | --- | --- | --- |
| login | text | 是 | 登陆名称 | - | demo |
| password | text | 是 | 密码 | - | demo |
### 返回正确JSON示例
```
{
"rc": 1, //(登陆成功)
"msg": "Success",
"token": "61cf62c724ad66f3c1c972045ce4acbf040d615d4b189f8daa5d607eed62dd01caa1f005df33c424e56b0c270556eb2f1c519dd019443c678b6bcfa34dc35fc0",
"admin_wp_id": 6 //（登陆用户的wordpress user id）
}
```
### 返回错误JSON示例
```
{
"rc": -1, (登陆失败)
"msg": "URL parameter missing" //（错误信息）
}
```
### 备注说明
无
## Data
### 请求地址
/api/data
### 请求类型
GET
### 请求参数
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
| --- | :---: | :---: | --- | --- | --- |
| page | text | 否 | 页面 | - | property |
| action | text | 是 | 见下表 | - | r_property |
| 前缀 | 动作 |
| :-: | :-: |
| c_ | 新增 |
| d_ | 删除 |
| u_ | 修改 |
| r_ | 查詢 |
### 页面详情
#### 物业页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 物业 -- 主页 | r_property | admin_wp_id | - | 是 | - | - |
| 物业 -- 新增物业 -- 提交 | c_property | multiple | 新增物业表单 | 是 | status: true | status: false |
| 物业 -- 更多 | r_property | property_id | - | 是 | - | - |
| 物业 -- 更多 -- 提交| u_property | multiple | 修改物业表单 | 是 | status: true | status: false |
| 物业 -- 删除| d_property | property_id | - | 是 | status: true | status: false |
#### 主页物管成员页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 物管成员 -- 主页 | r_users | admin_wp_id | - | 是 | - | - |
| | | category | propman | 否 | - | - |
| 物管成员 -- 新增 | c_users | multiple | 新增物管成员表单 | 是 | status: true | status: false |
| 物管成员 -- 更新 | u_users | multiple | 修改物管成员表单 | 是 | status: true | status: false |
| 物管成员 -- 删除 | d_users | user_id | - | 是 | status: true | status: false |
#### 主页法团成员页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 法团成员 -- 主页 | r_users | admin_wp_id | - | 是 | - | - |
| | | category | oc | 否 | - | - |
| 法团成员 -- 新增 | c_users | multiple | 新增法团成员表单 | 是 | status: true | status: false |
| 法团成员 -- 更新 | u_users | multiple | 修改法团成员表单 | 是 | status: true | status: false |
| 法团成员 -- 删除 | d_users | user_id | - | 是 | status: true | status: false |
#### 主页承办商成员页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 承办商成员 -- 主页 | r_users | admin_wp_id | - | 是 | - | - |
| | | category | Contractor | 否 | - | - |
| 承办商成员 -- 新增 | c_users | multiple | 新增承办商成员表单 | 是 | status: true | status: false |
| 承办商成员 -- 更新 | u_users | multiple | 修改承办商成员表单 | 是 | status: true | status: false |
| 承办商成员 -- 删除 | d_users | user_id | - | 是 | status: true | status: false |
#### 物管成员页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 更多 -- 物管成员 | r_propman | property_id | - | 是 | - | - |
| 更多 -- 物管成员 -- 新增 | c_propman | multiple | 新增物管成员表单 | 是 | status: true | status: false |
| 更多 -- 物管成员 -- 修改 | u_propman | multiple | 修改物管成员表单 | 是 | status: true | status: false |
| 更多 -- 物管成员 -- 删除 | d_propman | propman_id | - | 是 | status: true | status: false |
#### 法团成员页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 更多 -- 法团成员 | r_oc | property_id | - | 是 | - | - |
| 更多 -- 法团成员 -- 新增 | c_oc | multiple | 新增法团成员表单 | 是 | status: true | status: false |
| 更多 -- 法团成员 -- 修改 | u_oc | multiple | 修改法团成员表单 | 是 | status: true | status: false |
| 更多 -- 法团成员 -- 删除 | d_oc | oc_id | - | 是 | status: true | status: false |
#### 承办商成员页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 更多 -- 承办商成员 | r_contractor | property_id | - | 是 | - | - |
| 更多 -- 承办商成员 -- 新增 | c_contractor | multiple | 新增承办商成员表单 | 是 | status: true | status: false |
| 更多 -- 承办商成员 -- 修改 | u_contractor | multiple | 修改承办商成员表单 | 是 | status: true | status: false |
| 更多 -- 承办商成员 -- 删除 | d_contractor | contractor_id | - | 是 | status: true | status: false |
#### 大厦通告页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 更多 -- 大厦通告 | r_notice | property_id | - | 是 | - | - |
| 更多 -- 大厦通告 -- 新增 | c_notice | multiple | 新增大厦通告表单 | 是 | status: true | status: false |
| 更多 -- 大厦通告 -- 修改 | u_notice | multiple | 修改大厦通告表单 | 是 | status: true | status: false |
| 更多 -- 大厦通告 -- 删除 | d_notice | notice_id | - | 是 | status: true | status: false |
#### 政府法令页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 更多 -- 政府法令 | r_important | property_id | - | 是 | - | - |
| 更多 -- 政府法令 -- 新增 | c_important | multiple | 新增政府法令表单 | 是 | status: true | status: false |
| 更多 -- 政府法令 -- 修改 | u_important | multiple | 修改政府法令表单 | 是 | status: true | status: false |
| 更多 -- 政府法令 -- 删除 | d_important | important_id | - | 是 | status: true | status: false |
| 更多 -- 政府法令 -- 延长期限 | r_important_deadline | important_id | - | 是 | - | - |
| 更多 -- 政府法令 -- 延长期限 -- 新增 | u_important_deadline | multiple | 修改政府法令延长期限表单 | 是 | status: true | status: false |
| 更多 -- 政府法令 -- 延长期限 -- 删除 | d_important_deadline | important_deadline_id | - | 是 | status: true | status: false |
#### 会议记录页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 更多 -- 会议记录 | r_minutes | property_id | - | 是 | - | - |
| 更多 -- 会议记录 -- 新增 | c_minutes | multiple | 新增会议记录表单 | 是 | status: true | status: false |
| 更多 -- 会议记录 -- 更多 | u_minutes | multiple | 修改会议记录表单 | 是 | status: true | status: false |
| 更多 -- 会议记录 -- 删除 | d_minutes | minutes_id | - | 是 | status: true | status: false |
#### 单位列表页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 更多 -- 单位列表 | r_unit_list | property_id | - | 是 | - | - |
| 更多 -- 单位列表 -- 新增 | c_unit_list | multiple | 新增单位列表表单 | 是 | status: true | status: false |
| 更多 -- 单位列表 -- 更多 | u_unit_list | multiple | 修改单位列表表单 | 是 | status: true | status: false |
| 更多 -- 单位列表 -- 删除 | d_unit_list | unit_id | - | 是 | status: true | status: false |
#### 单位记录页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 更多 -- 单位记录 | r_unit_file | property_id | - | 是 | - | - |
| 更多 -- 单位记录 -- 新增 | c_unit_file | multiple | 新增单位记录表单 | 是 | status: true | status: false |
| 更多 -- 单位记录 -- 更多 | u_unit_file | multiple | 修改单位记录表单 | 是 | status: true | status: false |
| 更多 -- 单位记录 -- 删除 | d_unit_file | unit_file_id | - | 是 | status: true | status: false |
| 更多 -- 单位记录 -- 新增 -- 从单位列表中选取 | r_unit_list | property_id | - | 是 | - | - |
#### 常规合约页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 更多 -- 常规合约 | r_term_contract | property_id | - | 是 | - | - |
| 更多 -- 常规合约 -- 新增 | c_term_contract | multiple | 新增常规合约表单 | 是 | status: true | status: false |
| 更多 -- 常规合约 -- 更多 -- 提交 | u_term_contract | multiple | 修改常规合约表单 | 是 | status: true | status: false |
| 更多 -- 常规合约 -- 删除 | d_term_contract | term_contract_id | - | 是 | status: true | status: false |
| 更多 -- 常规合约 -- 更多 -- 新增相关人员(contracttype:term) | c_term_contract_related_entity | multiple | 新增相关人员表单 | 是 | status: true | status: false |
| 更多 -- 常规合约 -- 更多 -- 删除相关人员(contracttype:term) | d_term_contract_related_entity | term_contract_related_entity_id | - | 是 | status: true | status: false |
| 更多 -- 常规合约 -- 更多 -- 新增相关人员 -- 查找相关人员/公司 | r_oc | property_id | - | 是 | - | - |
| | r_propman | property_id | - | 是 | - | - |
| | r_contractor | property_id | - | 是 | - | - |
| 更多 -- 常规合约 -- 检查报告 | r_term_contract_regular_report | term_contract_id | - | 是 | - | - |
| 更多 -- 常规合约 -- 检查报告 -- 新增 | u_term_contract_regular_report | multiple | 修改政府法令延长期限表单 | 是 | status: true | status: false |
| 更多 -- 常规合约 -- 检查报告 -- 删除 | d_term_contract_regular_report | regular_report_id | - | 是 | status: true | status: false |
#### 一次性合约页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 更多 -- 一次性合约 | r_individual_contract | property_id | - | 是 | - | - |
| 更多 -- 一次性合约 -- 新增 | c_individual_contract | multiple | 新增一次性合约表单 | 是 | status: true | status: false |
| 更多 -- 一次性合约 -- 更多 -- 提交 | u_individual_contract | multiple | 修改一次性合约表单 | 是 | status: true | status: false |
| 更多 -- 一次性合约 -- 删除 | d_individual_contract | individual_contract_id | - | 是 | status: true | status: false |
| 更多 -- 一次性合约 -- 更多 -- 新增相关人员 | c_individual_contract_related_entity | multiple | 新增相关人员表单 | 是 | status: true | status: false |
| 更多 -- 一次性合约 -- 更多 -- 删除相关人员 | d_individual_contract_related_entity | individual_contract_related_entity_id | - | 是 | status: true | status: false |
| 更多 -- 一次性合约 -- 更多 -- 新增相关人员 -- 查找相关人员/公司 | r_oc | property_id | - | 是 | - | - |
| | r_propman | property_id | - | 是 | - | - |
| | r_contractor | property_id | - | 是 | - | - |
| 更多 -- 一次性合约 -- 工作报告 | r_individual_contract_work_report | individual_contract_id | - | 是 | - | - |
| 更多 -- 一次性合约 -- 工作报告 -- 新增 | u_individual_contract_work_report | multiple | 新增工作报告表单 | 是 | status: true | status: false |
| 更多 -- 一次性合约 -- 工作报告 -- 删除 | d_individual_contract_work_report | work_report_id | - | 是 | status: true | status: false |
#### 保险索赔页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 更多 -- 保险索赔 | r_insurance_claims | property_id | - | 是 | - | - |
| 更多 -- 保险索赔 -- 新增 | c_insurance_claims | multiple | 新增保险索赔表单 | 是 | status: true | status: false |
| 更多 -- 保险索赔 -- 更多 | u_insurance_claims | multiple | 修改保险索赔表单 | 是 | status: true | status: false |
| 更多 -- 保险索赔 -- 删除 | d_insurance_claims | insurance_claims_id | - | 是 | status: true | status: false |
#### 杂项页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 更多 -- 杂项 | r_notes | property_id | - | 是 | - | - |
| 更多 -- 杂项 -- 新增 | c_notes | multiple | 新增杂项表单 | 是 | status: true | status: false |
| 更多 -- 杂项 -- 更多 | u_notes | multiple | 修改杂项表单 | 是 | status: true | status: false |
| 更多 -- 杂项 -- 删除 | d_notes | note_id | - | 是 | status: true | status: false |
#### 检查表页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 更多 -- 检查表 | r_propman | property_id | - | 是 | - | - |
| | r_propman | property_id | - | 是 | - | - |
| | r_oc | property_id | - | 是 | - | - |
| | r_contractor | property_id | - | 是 | - | - |
| | r_individual_contract | property_id | - | 是 | - | - |
| | r_individual_contract_work_report | property_id | - | 是 | - | - |
| | r_term_contract | property_id | - | 是 | - | - |
| | r_term_contract_regular_report | property_id | - | 是 | - | - |
| | r_unit_list | property_id | - | 是 | - | - |
| | r_unit_file | property_id | - | 是 | - | - |
| | r_notice | property_id | - | 是 | - | - |
| | r_important | property_id | - | 是 | - | - |
| | r_minutes | property_id | - | 是 | - | - |
| | r_insurance_claims | property_id | - | 是 | - | - |
#### 日程页面详情
| 路径 | 动作 | 参数 | 值 | 必填 | 成功返回 | 错误返回 |
| :-- | :-- | :--- | :-- | :--- | :-- | :-- |
| 更多 -- 日程 | r_calendar | property_id | int | 是 | 日程列表 + 分类 + agm| - |
| App -- 日历 | r_calendar | by_date | 1 | 否 | 日程列表（按日期）| - |
| App -- 日历 | r_calendar | date | 日期 | 否 | -1 ~ +6 个月的日程 | - |
| App -- 日历 | r_calendar | type | 1 | 否 | 只显示分类 | - |
| App -- 日历 | r_calendar | agm | 1 | 否 | 显示未来最近一个AGM | - |
| 更多 -- 日程 -- 新增 | c_calendar | property_id | int | 是 | status: true | status: false |
| 更多 -- 日程 -- 新增 | c_calendar | time | date time | 是 | status: true | status: false |
| 更多 -- 日程 -- 新增 | c_calendar | priority | 2高 1中 0低 | 是 | status: true | status: false |
| 更多 -- 日程 -- 新增 | c_calendar | type | int | 是 | status: true | status: false |
| 更多 -- 日程 -- 新增 | c_calendar | description | text | 是 | status: true | status: false |
| 更多 -- 日程 -- 新增 | c_calendar | notification | 1开 0关 | 是 | status: true | status: false |
| 更多 -- 日程 -- 修改 | u_calendar | 同新增 | 修改日程表单 | 是 | status: true | status: false |
| 更多 -- 日程 -- 删除 | d_calendar | calendar_id | int | 是 | status: true | status: false |
### 备注说明
无