当前位置：首页 > 行业动态 > 正文

如何使用API queryInspectTimesRank 来查询特定门店及其员工巡检次数的排名?

admin
行业动态
2024-10-21
1

该API用于查询门店或人员的巡检次数排名。

为了帮助您更好地理解如何通过API查询门店或人员的巡检次数排名，我将详细解释该API的用途、输入参数、响应格式以及示例。

如何使用API queryInspectTimesRank 来查询特定门店及其员工巡检次数的排名? 第1张

API简介

API名称：queryInspectTimesRank

该API用于查询指定时间段内各门店或人员的巡检次数排名，通过此API，用户可以快速了解哪个门店或人员在巡检工作中表现最为积极，从而为管理决策提供数据支持。

输入参数

参数名称	类型	必填	描述
start_date	string	是	查询开始日期，格式为YYYYMMDD
end_date	string	是	查询结束日期，格式为YYYYMMDD
target_type	string	是	查询目标类型，”store”表示门店，”staff”表示人员
target_id	string	否	若target_type为”store”，则此处传入门店ID；若target_type为”staff”，则此处传入员工ID

响应格式

API返回一个JSON对象，包含以下字段：

字段名	类型	描述
code	int	响应状态码，0表示成功，其他值表示失败及原因代码
message	string	响应消息，简要描述请求结果
data	array	巡检次数排名数据，详见下文data结构说明

data结构说明：

当target_type为"store"时：

字段名	类型	描述
store_id	string	门店ID
store_name	string	门店名称
inspect_times	int	巡检次数
rank	int	排名（按巡检次数降序排列）

当target_type为"staff"时：

字段名	类型	描述
staff_id	string	员工ID
staff_name	string	员工姓名
inspect_times	int	巡检次数
rank	int	排名（按巡检次数降序排列）

示例

假设您想查询2023年1月1日至2023年1月31日期间，所有门店的巡检次数排名，可以这样调用API：

GET /api/queryInspectTimesRank?start_date=20230101&end_date=20230131&target_type=store

如果响应成功，将返回类似如下的JSON：

{
  "code": 0,
  "message": "查询成功",
  "data": [
    {
      "store_id": "S001",
      "store_name": "门店A",
      "inspect_times": 15,
      "rank": 1
    },
    {
      "store_id": "S002",
      "store_name": "门店B",
      "inspect_times": 12,
      "rank": 2
    },
    ...
  ]
}

同样地，如果您想查询同一时间段内，员工李四的巡检次数排名，只需将target_type改为"staff"，并将target_id设置为李四的员工ID即可。