1. 组织中台API

API列表

编号 API名称 路径 版本
1.1 获取机构列表 /mid/orgz/struct/query/list 1.0
1.2 获取机构信息 /mid/orgz/struct/query/info 1.0
1.3 创建机构 /mid/orgz/struct/create 1.0
1.4 更新机构信息 /mid/orgz/struct/update/info 1.0
1.5 更新机构数据状态 /mid/orgz/struct/update/state 1.0
1.6 获取员工列表 /mid/orgz/staff/query/list 1.0
1.7 获取员工信息 /mid/orgz/staff/query/info 1.0
1.8 创建员工 /mid/orgz/staff/create 1.0
1.9 更新员工信息 /mid/orgz/staff/update/info 1.0
1.10 更新员工数据状态 /mid/orgz/staff/update/state 1.0
1.11 更新员工账号 /mid/orgz/staff/credentials/acct 1.0
1.12 验证员工账号 /mid/orgz/staff/credentials/auth 1.0

API调用

1.1: 获取机构列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/orgz/struct/query/list

方法：POST

请求参数

名称 位置 类型 必填 描述
clazzCode BODY STRING 否 机构分类
typeCode BODY STRING 否 机构类型
beginModifyTimestamp BODY STRING 否 需要查询的数据的时间戳范围，格式为：yyyy-MM-dd HH:mm:ss
endModifyTimestamp BODY STRING 否 需要查询的数据的时间戳范围，格式为：yyyy-MM-dd HH:mm:ss
organId BODY STRING 否 机构ID
pageNo BODY INTEGER 是 当前页
pageSize BODY INTEGER 是 每页条数

请求Body描述(非Form表单数据)

{
  "clazzCode": "01",
  "typeCode": "01",
  "beginModifyTimestamp": "2017-07-22 17:19:21",
  "endModifyTimestamp": "2018-08-22 17:19:21",
  "organId": 21291118,
  "pageNo": 1,
  "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
organStructs data JSONArray 是 机构列表
organId data.organStructs[] STRING 是 机构ID
name data.organStructs[] STRING 是 机构名
parId data.organStructs[] STRING 是 父级ID
pyName data.organStructs[] STRING 是 机构名拼音
regTime data.organStructs[] STRING 是 注册时间
organType data.organStructs[] STRING 是 机构类型
total data INTEGER 是 总条数
pages data INTEGER 是 总页数
pageNo data INTEGER 是 当前页
pageSize data INTEGER 是 每页条数
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
       "total": 174716,
     "pages": 8736,
     "pageNo": 1,
       "pageSize": 10,
     "organStructs":[{
         "organId":"",
         "name":"",
         "parId":"",
         "pyName":"",
         "regTime":"",
         "organType":""
     }]
  }
}

1.2: 获取机构信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/orgz/struct/query/info

方法：POST

请求参数

名称 位置 类型 必填 描述
clazzCode BODY STRING 否 机构分类
typeCode BODY STRING 否 机构类型
organId BODY STRING 是 机构ID

请求Body描述(非Form表单数据)

{
  "clazzCode": "01",
  "typeCode": "01",
  "organId":""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
organStruct data JSONObject 是 机构列表
organId data.organStructs[] STRING 是 机构ID
name data.organStructs[] STRING 是 机构名
parId data.organStructs[] STRING 是 父级ID
pyName data.organStructs[] STRING 是 机构名拼音
regTime data.organStructs[] STRING 是 注册时间
organType data.organStructs[] STRING 是 机构类型
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
     "organStruct":{
         "organId":"",
         "name":"",
         "parId":"",
         "pyName":"",
         "regTime":"",
         "organType":""
     }
  }
}

1.3: 创建机构

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/orgz/struct/create

方法：POST

请求参数

名称 位置 类型 必填 描述
clazzCode BODY STRING 否 机构分类
typeCode BODY STRING 否 机构类型
name BODY STRING 是 机构名
parId BODY STRING 是 父级ID
pyName BODY STRING 是 机构名拼音
regTime BODY STRING 是 注册时间
organType BODY STRING 是 机构类型

请求Body描述(非Form表单数据)

{
  "clazzCode": "01",
  "typeCode": "01",
  "organStruct":{
         "name":"",
         "parId":"",
         "pyName":"",
         "regTime":"",
         "organType":""
     }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
organId data.organStructs[] STRING 是 机构ID
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
     "organId":""
  }
}

1.4: 更新机构信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/orgz/struct/update/info

方法：POST

请求参数

名称 位置 类型 必填 描述
clazzCode BODY STRING 否 机构分类
typeCode BODY STRING 否 机构类型
organId BODY STRING 是 机构ID
name BODY STRING 是 机构名
parId BODY STRING 是 父级ID
pyName BODY STRING 是 机构名拼音
regTime BODY STRING 是 注册时间
organType BODY STRING 是 机构类型

请求Body描述(非Form表单数据)

{
  "clazzCode": "01",
  "typeCode": "01",
  "organStruct":{
         "organId":"",
         "name":"",
         "parId":"",
         "pyName":"",
         "regTime":"",
         "organType":""
     }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {

  }
}

1.5: 更新机构数据状态

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/orgz/struct/update/state

方法：POST

请求参数

名称 位置 类型 必填 描述
clazzCode BODY STRING 否 机构分类
typeCode BODY STRING 否 机构类型
organId BODY STRING 是 机构ID
status BODY STRING 是 状态:0 为无效，1为有效

请求Body描述(非Form表单数据)

{
  "clazzCode": "01",
  "typeCode": "01",
  "organId":"",
  "status":""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {

  }
}

1.6: 获取员工列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/orgz/staff/query/list

方法：POST

请求参数

名称 位置 类型 必填 描述
clazzCode BODY STRING 否 机构分类
typeCode BODY STRING 否 机构类型
organId BODY STRING 否 机构ID
pageNo BODY INTEGER 是 当前页
pageSize BODY INTEGER 是 每页条数

请求Body描述(非Form表单数据)

{
  "clazzCode": "01",
  "typeCode": "01",
  "organId": "",
  "pageNo": 1,
  "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
staffStructs data JSONArray 是 机构列表
staffId data.staffStructs[] STRING 是 员工ID
organId data.staffStructs[] STRING 是 所属机构ID
email data.staffStructs[] STRING 是 邮箱
name data.staffStructs[] STRING 是 名称
sex data.staffStructs[] STRING 是 性别1为女，2为男
tel data.staffStructs[] STRING 是 电话
type data.staffStructs[] STRING 是 用户类型: 1:物管用户，4:商户用户,8:平台管理用户
jobNumber data.staffStructs[] STRING 是 工号
pyName data.staffStructs[] STRING 是 拼音简称
total data INTEGER 是 总条数
pages data INTEGER 是 总页数
pageNo data INTEGER 是 当前页
pageSize data INTEGER 是 每页条数
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
       "total": 174716,
     "pages": 8736,
     "pageNo": 1,
     "pageSize": 10,
     "staffStructs":[{
         "sex": 2,
        "name": "",
        "pyName": "",
        "organId": 21311118,
        "tel": "",
        "type": 1,
        "staffId": 7053432,
        "email": "",
        "jobNumber": ""
     }]
  }
}

1.7: 获取员工信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/orgz/staff/query/info

方法：POST

请求参数

名称 位置 类型 必填 描述
clazzCode BODY STRING 否 机构分类
typeCode BODY STRING 否 机构类型
organId BODY STRING 否 机构ID
staffId BODY STRING 否 员工

请求Body描述(非Form表单数据)

{
  "clazzCode": "01",
  "typeCode": "01",
  "organId": "",
  "staffId":""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
staffStruct data JSONArray 是 机构列表
staffId data.staffStructs[] STRING 是 员工ID
organId data.staffStructs[] STRING 是 所属机构ID
email data.staffStructs[] STRING 是 邮箱
name data.staffStructs[] STRING 是 名称
sex data.staffStructs[] STRING 是 性别1为女，2为男
tel data.staffStructs[] STRING 是 电话
type data.staffStructs[] STRING 是 用户类型: 1:物管用户，4:商户用户,8:平台管理用户
jobNumber data.staffStructs[] STRING 是 工号
pyName data.staffStructs[] STRING 是 拼音简称
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
     "staffStruct":{
         "sex": 2,
        "name": "",
        "pyName": "",
        "organId": 21311118,
        "tel": "",
        "type": 1,
        "staffId": 7053432,
        "email": "",
        "jobNumber": ""
     }
  }
}

1.8: 创建员工

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/orgz/staff/create

方法：POST

请求参数

名称 位置 类型 必填 描述
clazzCode BODY STRING 否 机构分类
typeCode BODY STRING 否 机构类型
organId BODY STRING 是 所属机构ID
email BODY STRING 是 邮箱
name BODY STRING 是 名称
sex BODY STRING 是 性别
tel BODY STRING 是 电话

请求Body描述(非Form表单数据)

{
  "clazzCode": "01",
  "typeCode": "01",
  "staffStruct":{
         "organId":"",
         "email":"",
         "name":"",
         "sex":"",
         "tel":""
     }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
staffId data STRING 是 员工ID
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
     "staffId":""
  }
}

1.9: 更新员工信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/orgz/staff/update/info

方法：POST

请求参数

名称 位置 类型 必填 描述
clazzCode BODY STRING 否 机构分类
typeCode BODY STRING 否 机构类型
staffId BODY STRING 是 员工ID
organId BODY STRING 是 所属机构ID
email BODY STRING 是 邮箱
name BODY STRING 是 名称
sex BODY STRING 是 性别
tel BODY STRING 是 电话

请求Body描述(非Form表单数据)

{
  "clazzCode": "01",
  "typeCode": "01",
  "staffStruct":{
          "staffId":"",
         "organId":"",
         "email":"",
         "name":"",
         "sex":"",
         "tel":""
     }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {

  }
}

1.10: 更新员工数据状态

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/orgz/staff/update/state

方法：POST

请求参数

名称 位置 类型 必填 描述
clazzCode BODY STRING 否 机构分类
typeCode BODY STRING 否 机构类型
staffId BODY STRING 是 员工ID
status BODY STRING 是 状态

请求Body描述(非Form表单数据)

{
  "clazzCode": "01",
  "typeCode": "01",
  "staffId":"",
  "status":""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {

  }
}

1.11: 更新员工账号

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/orgz/staff/credentials/acct

方法：POST

请求参数

名称 位置 类型 必填 描述
clazzCode BODY STRING 否 机构分类
typeCode BODY STRING 否 机构类型
staffId BODY STRING 是 员工ID
tel BODY STRING 是 手机号

请求Body描述(非Form表单数据)

{
  "clazzCode": "01",
  "typeCode": "01",
  "staffId":"",
  "tel":""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {

  }
}

1.12: 验证员工账号

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/orgz/staff/credentials/auth

方法：POST

请求参数

名称 位置 类型 必填 描述
clazzCode BODY STRING 否 机构分类
typeCode BODY STRING 否 机构类型
uid BODY STRING 否 用户账号
password BODY STRING 否 用户aes加密后的密码

请求Body描述(非Form表单数据)

{
  "clazzCode": "01",
  "typeCode": "01",
  "uid":"",
  "password":""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {

  }
}
异常返回示例
{"code":"1101","message":""}

错误码列表(1101-1199)

错误码 错误信息 描述
1101 the organize not exists 组织不存在
公共错误码 -- 所有API公用的错误码，请参照《 公共错误码 》

results matching ""

    No results matching ""