管理员接口 ​

简介 ​

管理员接口支持对管理员用户进行查询、添加、修改等相关操作。

开发前，请仔细阅读 开发指南。

接口调用 ​

1. 获取用户信息 ​

请求地址 ​

http
GET /User/Current

返回结果 ​

json
{
     "user": {
        "enterpriseName": "测试",
        "roles": [
              {
                "id": 15805,
                "name": "管理者",
                "comment": "流程用",
                "isDelete": false
            }
        ],
        "menus": [
            {
                "name": "资产管理",
                "menuId": 1
            },
            {
                "name": "资产入库",
                "parentMenuId": 1,
                "menuId": 2
            },
            {
                "name": "领用退库",
                "parentMenuId": 1,
                "menuId": 3
            }
        ],
        "rfidAvaliable": false,
        "relatedEmployeeNo": "000001",
        "relatedEmployeeName": "阿敏",
        "relatedEmployeePhoneNumber": "15831188099",
        "id": 6261,
        "userName": "shangde@123.com",
        "name": "尚德",
        "isAdministrator": true,
        "deleted": false,
        "pushClientId": "",
        "relatedEmployeeId": "dbb5aa65-8f1c-4d69-8366-49823fe978a3"
    }
}

结果说明 ​

属性名称说明
user用户信息详情
roles角色信息合集
menus菜单权限合集
rfidAvaliable是否开启rfid
relatedEmployeeNo关联员工编码
relatedEmployeeName关联员工名称
relatedEmployeePhoneNumber关联员工手机号
id用户id
userName用户名
name用户姓名
isAdministrator是否超级管理员
deleted是否被禁用
pushClientId推送ClientId
relatedEmployeeId关联员工id

角色信息 ​

属性名称说明
id角色id
name角色名
comment备注
isDelete是否被删除

菜单权限 ​

属性名称说明
name菜单名称
parentMenuId父级菜单id
menuId菜单id

2. 设置PushClientId ​

请求地址 ​

http
PUT /User/Current/Message/Setting
POST /User/Current/Message/Setting/put

对于不支持PUT请求的网络环境，请尝试使用备份的POST请求地址

请求示例 ​

json
{
    "PushClientId":"3725581",
    "_clientType":"1"
}

参数说明 ​

参数是否必须说明
PushClientId是PushClientId
_clientType是默认传1

返回结果 ​

json
{}

对于成功发送的请求，该接口仅返回HTTP 200 OK

3. 获取签字、申情单审批设置 ​

请求地址 ​

http
GET /Settings/Integration

对于不支持PUT请求的网络环境，请尝试使用备份的POST请求地址

返回结果 ​

json
{
    "companyIntegration": [
        {
            "id": 52433,
            "code": "113",
            "name": "113",
            "enterpriseId": 4506,
            "superiorCompanyId": 50715,
            "disabled": false,
            "hierarchy": "50715|52433"
        }
    ],
    "settings": [
        {
            "name": "AssetUseApplication",
            "value": "0",
            "remark": "资产借用申请是否需要审批(1 审批,0 不审批)"
        },
        {
            "name": "AssetBorrowApplication",
            "value": "1",
            "remark": "资产借用申请是否需要审批(1 审批,0 不审批)"
        },
        {
            "name": "AssetRevertApplication",
            "value": "0",
            "remark": "资产退库申请是否需要审批(1 审批,0 不审批)"
        },
        {
            "name": "AssetIsSignature",
            "value": "0",
            "remark": "资产是否签字(1 签字,0 不签字)"
        },
        {
            "name": "AssetUseIsSignature",
            "value": "0",
            "remark": "资产领用单是否签字(1 签字,0 不签字)"
        },
        {
            "name": "AssetRevertIsSignature",
            "value": "0",
            "remark": "资产退库单是否签字(1 签字,0 不签字)"
        },
        {
            "name": "AssetBorrowIsSignature",
            "value": "0",
            "remark": "资产借用归还单是否签字(1 签字,0 不签字)"
        },
        {
            "name": "AssetOtherIsSignature",
            "value": "0",
            "remark": "实物信息变更单是否签字(1 签字,0 不签字)"
        },
        {
            "name": "AssetMaintenanceIsSignature",
            "value": "0",
            "remark": "维保信息变更单是否签字(1 签字,0 不签字)"
        },
        {
            "name": "AssetFinanceIsSignature",
            "value": "1",
            "remark": "资产财务信息单是否签字(1 签字,0 不签字)"
        },
        {
            "name": "AssetRepairIsSignature",
            "value": "0",
            "remark": "资产维修单是否签字(1 签字,0 不签字)"
        },
        {
            "name": "AssetClearIsSignature",
            "value": "0",
            "remark": "资产清理报废单是否签字(1 签字,0 不签字)"
        },
        {
            "name": "HCOutStorageApplication",
            "value": "0",
            "remark": "耗材出库是否需要审批(1 审批,0 不审批)"
        },
        {
            "name": "HCInStorageIsSignature",
            "value": "0",
            "remark": "耗材入库单是否签字(1 签字,0 不签字)"
        },
        {
            "name": "HCCXInStorageIsSignature",
            "value": "1",
            "remark": "耗材冲销单是否签字(1 签字,0 不签字)"
        },
        {
            "name": "HCProfitInStorageIsSignature",
            "value": "1",
            "remark": "耗材盘盈入库单是否签字(1 签字,0 不签字)"
        },
        {
            "name": "HCOutStorageIsSignature",
            "value": "2",
            "remark": "耗材出库单是否签字(1 签字,0 不签字)"
        },
        {
            "name": "HCTKOutStorageIsSignature",
            "value": "1",
            "remark": "耗材退库单是否签字(1 签字,0 不签字)"
        },
        {
            "name": "HCLossOutStorageIsSignature",
            "value": "1",
            "remark": "耗材盘亏出库单是否签字(1 签字,0 不签字)"
        },
        {
            "name": "StorageType",
            "value": "0"
        }
    ]
}

结果说明 ​

属性名称说明
companyIntegration可用公司详情合集
settings签字、申请单审批设置合集

可用公司详情 ​

属性名称说明
id公司id
code公司编码
name公司名称
enterpriseId企业id
disabled是否被禁用
hierarchy层级展示（父级在前，子级在后）

签字、申情单审批设置 ​

属性名称说明
name设置名称
value申请单设置（0:不需要审批、1:需要审批）；签字设置（0:不需要签字、1:需要app签字、2:需要员工端签字）
remark备注

4. 获取所有用户列表 ​

请求地址 ​

http
GET /User

参数说明 ​

用户列表查询接口支持丰富的条件过滤参数，请参见支持的查询参数附录 ​

返回结果 ​

json
{
    "offset": 0,
    "total": 0,
    "results": [
        {
            "relatedEmployeeNo": "000001",
            "relatedEmployeeName": "阿敏",
            "relatedCompanyCode": "3725581",
            "relatedCompanyName": "恶魔",
            "relatedDepartmentCode": "27275",
            "relatedDepartmentName": "测试吧",
            "id": 55048,
            "userName": "shangde@112.com",
            "name": "管理二",
            "isAdministrator": false,
            "deleted": false,
            "pushClientId": "3725581",
            "relatedEmployeeId": "dbb5aa65-8f1c-4d69-8366-49823fe978a3"
        }
    ],
    "meta": {}
}
参数说明
offset当前结果对于首条结果的偏移量，指定分页查询时不为0
total所有符合查询条件的查询结果数量，指定需要结果记录数量时不为0
results符合查询条件的用户详情集合
meta其他信息

5. 编辑用户信息 ​

请求地址 ​

http
POST /User/Manage/put

请求示例 ​

json
{
    "userName":"xxx@xxx.com",
    "name":"xxxx",
    "password":"123456",
    "employeeNo":"10001",
    "currentUserName":"xxx@xxx.com"
}

参数说明 ​

参数是否必须参数类型说明
userName是String编辑后的用户账号
name是String用户名称
password是String用户密码
employeeNo是String关联员工的工号
currentUserName是String编辑前的用户账号

返回结果 ​

json
{}

对于成功发送的请求，该接口仅返回HTTP 200 OK

6. 设置用户禁用、启用状态 ​

请求地址 ​

http
POST /User/Manage/EnablesOrDisables

请求示例 ​

json
{
    "userName":"xxx@xxx.com",
    "enabled":"0"
}

参数说明 ​

参数是否必须参数类型说明
userName是String用户账号
enabled是Int禁用状态，传0是禁用，传1是启用

返回结果 ​

json
{}

对于成功发送的请求，该接口仅返回HTTP 200 OK

附录 ​

1. 支持的查询参数 ​

如无特别说明，下列操作对于查询实体对象中的任意属性均适用。使用时只需将其追加至请求的querystring中即可。对实体对象中不存在的属性进行操作将会得到不可预期的结果。

  • 分页
    • skip={数字} 跳过指定条数的记录数
    • take={数字} 取出指定条数的记录数（注：最大值为1500，即单页最多返回1500条数据）
    • include=total 需要返回记录总数
  • 排序
    • orderBy=[-]{属性名称},[-]{属性名称} 返回结果按指定属性排序，在名称前加”-“表示按倒序排序。多个属性的排序可使用逗号分隔。如：orderBy=-Id,Name,-Age
  • 条件过滤

    • 不等于

      • {属性名称}!={值} 如：Id!=1

    • 大于等于

      • >{属性名称}={值} 如：>Id=1

    • 大于

      • {属性名称}>={值} 如：Id>=1

    • 小于

      • <{属性名称}={值} 如：<Id=1

    • 小于等于

      • {属性名称}<={值} 如：Id<=1

    • In

      • {属性名称}In={值，值，值} 属性的值需包含在指定的集合中，如：IdIn=1,2,3

    • Between

      • {属性名称}Between={值，值} 属性的值需处于指定的区间之间，仅支持数字，如： IdBetween=1,3

    • 字符串包含指定字符

      • {属性名称}Contains={值} 如：nameContains=abc

    • 字符串以指定字符开头

      • {属性名称}StartsWith={值} 如：nameStartsWith=abc

    • 字符串以指定字符结尾

      • {属性名称}EndsWith={值} 如：nameEndsWith=abc

2. 数据实体格式 ​

1. 用户详情数据对象格式 ​
属性名称说明
relatedEmployeeNo关联员工编码
relatedEmployeeName关联员工名称
relatedCompanyCode关联公司编码
relatedCompanyName关联公司名称
relatedDepartmentCode关联部门编码
relatedDepartmentName关联部门名称
id用户id
userName用户名
name用户姓名
isAdministrator是否超级管理员
deleted是否被禁用
pushClientId推送ClientId
relatedEmployeeId关联员工id