企业基础数据统计接口

功能说明

具体包含学生、学校、实时终端数量

默认接口请求频率限制：20次/秒。

实现方法

REST URL

POST https://sdk.xylink.com/api/rest/edu/external/statistics/school/data/custom/v1?enterpriseId=分配的企业id

请求参数说明

参数	参数类型	参数位置	必须	默认值	说明
thirdDeptIds	List<String>	Body	否	无	三方批量部门ID(不超过10,否则报错)
areaType	Integer	Body	否	无	区域码(1-省，2-市，3-县)
areaCode	Long	Body	否	无	行政区域码

示例代码

请求消息体示例（Json）

{
    "thirdDeptIds":[12345, 12398] //强制规定数量不超过10个
}

或者

{
  "areaType":1/2/3,
  "areaCode":123
}

补充说明: 三方部门、区域码必须二选一条件查询数据,部门优先级更高

示例代码

返回结果示例：

成功时返回结果数据，失败时返回小鱼RESTAPI错误码

{
  "areaCode": 520000, //区域码,当根据区域码查询时返回
  "areaName":"区域名称" //区域码对应的名称,当根据区域码查询时返回
  "studentCount": 1000, //学生数量
  "schoolCount": 85, //学校数量
  "deviceCount": 2345, //终端总量
  "onlineDeviceCount": 100, //在线终端数量（不包含呼叫中）
  "offlineDeviceCount": 100, //离线的终端数量
  "callingDeviceCount": 23, //呼叫终端数量
  "offlineDeviceCount": 23, //离线终端数量
  "childs": [ //子数据项,当根据区域码查询时返回
    {
      "areaCode": 0,
      "areaName":""
      "studentCount": 0,
      "schoolCount": 0,
      "deviceCount": 0,
      "onlineDeviceCount": 0,
      "offlineDeviceCount": 100,
      "callingDeviceCount": 0,
      "offlineDeviceCount": 23    }
  ]
}

返回参数说明

参数名称	说明
areaCode	区域码
areaName	区域名称
studentCount	学生数量
schoolCount	学校数量
deviceCount	终端总量
onlineDeviceCount	在线终端数量（不包含呼叫中）
offlineDeviceCount	离线的终端数量
callingDeviceCount	呼叫终端数量
offlineDeviceCount	离线终端数量

2022-10-12 14:38:24

导出PDF文档