usersCheckInfos

URI

<users_uri>/checkinfos[.<format>]

支持的方法

GET、PUT、DELETE、HEAD

父资源

users

介绍

usersCheckInfos 资源是用户审核信息列表资源。只有拥有用户审核权限的管理员才能使用该资源。通过发送 GET 请求，可以获取用户审核信息列表，通过发送 PUT 请求，可以更新用户审核信息列表，通过发送 DELETE 请求，可以删除用户的审核记录。

支持的方法：

支持的表述格式：RJSON、JSON、HTML、XML。

资源层次

HTTP 请求方法

对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiportal 是服务器名。

http://supermapiportal:8190/iportal/web/users/checkinfos.rjson

GET 请求

获取用户审核信息列表。

请求参数

发送请求时，需要在请求体中传递如下参数：

名称 类型 含义
checkStatuses CheckStatus[] 根据审核状态过滤。
orderBy CheckInfoOrderBy 根据用户注册时间、审核时间、用户名称或昵称排序过滤。
currentPage int 根据当前第几页过滤。
pageSize int 根据每页大小过滤。
orderType OrderType 根据排序时升降序过滤。

响应结构

返回的资源表述结构如下：

字段 类型 说明
content List<CheckInfoContent> 页面内容。
currentPage int 当前第几页。
pageSize int 每页大小。
searchParameter SearchParameter 当前页搜索参数。
total int 总记录数。
totalPage int 总页数。

响应示例

对 usersCheckInfos 资源：:http://localhost:8190/iportal/web/users/checkinfos.rjson 执行 GET 请求，返回 rjson 格式的资源表述如下：

{

    "content": [

        {

            "checkStatus": "UNCHECKED",

            "checkTime": null,

            "checkUser": null,

            "checkUserNick": null,

            "createTime": 1482723439580,

            "departmentId": null,

            "id": 1,

            "objectInfo": {

                "departmentId": 1,

                "departmentNames": null,

                "description": null,

                "email": "user1@163.com",

                "isLocked": false,

                "name": "user1",

                "nickname": "user1",

                "ownRoles": null,

                "password": "user1`12",

                "passwordLastModified": null,

                "passwordQuestion": {

                    "pwdAnswer": "cangzhong",

                    "pwdQuestion": "school"

                },

                "roles": [

                    "PORTAL_USER"

                ],

                "userGroups": null

            },

            "verifyReason": null

        },

        {

            "checkStatus": "UNCHECKED",

            "checkTime": null,

            "checkUser": null,

            "checkUserNick": null,

            "createTime": 1482734036718,

            "departmentId": null,

            "id": 2,

            "objectInfo": {

                "departmentId": 1,

                "departmentNames": null,

                "description": null,

                "email": "user2@163.com",

                "isLocked": false,

                "name": "user2",

                "nickname": "user2",

                "ownRoles": null,

                "password": "user2`12",

                "passwordLastModified": null,

                "passwordQuestion": {

                    "pwdAnswer": "cangzhong",

                    "pwdQuestion": "school"

                },

                "roles": [

                    "PORTAL_USER"

                ],

                "userGroups": null

            },

            "verifyReason": null

        },

        {

            "checkStatus": "UNCHECKED",

            "checkTime": null,

            "checkUser": null,

            "checkUserNick": null,

            "createTime": 1482734623984,

            "departmentId": null,

            "id": 3,

            "objectInfo": {

                "departmentId": 1,

                "departmentNames": null,

                "description": null,

                "email": "xiaoli@163.com",

                "isLocked": false,

                "name": "xiaoli",

                "nickname": "xiaoli",

                "ownRoles": null,

                "password": "xiaoli`12",

                "passwordLastModified": null,

                "passwordQuestion": {

                    "pwdAnswer": "shangcang",

                    "pwdQuestion": "school"

                },

                "roles": [

                    "PORTAL_USER"

                ],

                "userGroups": null

            },

            "verifyReason": null

        }

    ],

    "currentPage": 1,

    "pageSize": 9,

    "searchParameter": {

        "checkStatuses": null,

        "currentPage": 1,

        "departmentIds": null,

        "keywords": null,

        "mapIds": null,

        "objectType": "USER",

        "orderBy": null,

        "orderType": "ASC",

        "pageSize": 9,

        "serviceIds": null

    },

    "total": 3,

    "totalPage": 1

}

如果希望获取指定的审核列表信息，如根据审核的状态和注册用户名称降序过滤，则需要设置 checkStatuses=["UNCHECKED"]&orderBy="USERNAME"&orderType=DESC，即对 usersCheckInfos 资源：http://localhost:8190/iportal/web/users/checkinfos.rjson?checkStatuses=["UNCHECKED"]&orderBy=USERNAME&orderType=DESC 执行 GET 请求，获取当前登录用户指定的申请列表信息，返回的 rjson 格式的资源表述如下：

{

    "content": [

        {

            "checkStatus": "UNCHECKED",

            "checkTime": null,

            "checkUser": null,

            "checkUserNick": null,

            "createTime": 1482734623984,

            "departmentId": null,

            "id": 3,

            "objectInfo": {

                "departmentId": 1,

                "departmentNames": null,

                "description": null,

                "email": "xiaoli@163.com",

                "isLocked": false,

                "name": "xiaoli",

                "nickname": "xiaoli",

                "ownRoles": null,

                "password": "xiaoli`12",

                "passwordLastModified": null,

                "passwordQuestion": {

                    "pwdAnswer": "shangcang",

                    "pwdQuestion": "school"

                },

                "roles": [

                    "PORTAL_USER"

                ],

                "userGroups": null

            },

            "verifyReason": null

        },

        {

            "checkStatus": "UNCHECKED",

            "checkTime": null,

            "checkUser": null,

            "checkUserNick": null,

            "createTime": 1482734036718,

            "departmentId": null,

            "id": 2,

            "objectInfo": {

                "departmentId": 1,

                "departmentNames": null,

                "description": null,

                "email": "user2@163.com",

                "isLocked": false,

                "name": "user2",

                "nickname": "user2",

                "ownRoles": null,

                "password": "user2`12",

                "passwordLastModified": null,

                "passwordQuestion": {

                    "pwdAnswer": "cangzhong",

                    "pwdQuestion": "school"

                },

                "roles": [

                    "PORTAL_USER"

                ],

                "userGroups": null

            },

            "verifyReason": null

        },

        {

            "checkStatus": "UNCHECKED",

            "checkTime": null,

            "checkUser": null,

            "checkUserNick": null,

            "createTime": 1482723439580,

            "departmentId": null,

            "id": 1,

            "objectInfo": {

                "departmentId": 1,

                "departmentNames": null,

                "description": null,

                "email": "user1@163.com",

                "isLocked": false,

                "name": "user1",

                "nickname": "user1",

                "ownRoles": null,

                "password": "user1`12",

                "passwordLastModified": null,

                "passwordQuestion": {

                    "pwdAnswer": "cangzhong",

                    "pwdQuestion": "school"

                },

                "roles": [

                    "PORTAL_USER"

                ],

                "userGroups": null

            },

            "verifyReason": null

        }

    ],

    "currentPage": 1,

    "pageSize": 9,

    "searchParameter": {

        "checkStatuses": [

            "UNCHECKED"

        ],

        "currentPage": 1,

        "departmentIds": null,

        "keywords": null,

        "mapIds": null,

        "objectType": "USER",

        "orderBy": "USERNAME",

        "orderType": "DESC",

        "pageSize": 9,

        "serviceIds": null

    },

    "total": 3,

    "totalPage": 1

}

PUT 请求

更新用户审核信息列表。

请求参数

发送请求时，需要在请求体中传递如下参数：

名称 类型 含义
ids Integer[] 审核记录的 id 数组。
checkInfo CheckInfo 审核信息。

响应结构

返回的资源表述结构如下：

字段 类型 说明
succeed boolean 审核指定的注册用户记录是否成功。
error Httperror 出错信息，如果审核指定的注册用户记录成功，则没有本字段。

响应示例

对 usersCheckInfos  资源:http://localhost:8190/iportal/web/users/checkinfos.rjson 执行 PUT 请求，审核指定的注册用户记录，发送请求体如下：

{

    "ids": [

        3

    ],

    "checkInfo": {

        "checkStatus": "SUCCESSFUL",

        "verifyReason": ""

    }

}

则返回的 rjson 格式响应结果如下：

{"succeed": true}

DELETE 请求

删除注册用户的审核记录，支持批量删除。url 中传递需要删除的审核记录的 id 数组。

响应结构

返回的资源表述结构如下：

字段 类型 说明
succeed boolean 删除服务申请单是否成功。
error Httperror 出错信息，如果删除服务申请单成功，则没有本字段。

响应示例

对 usersCheckInfos 资源：http://localhost:8190/iportal/web/users/checkinfos.rjson?ids=[1,2] 执行 DELETE 请求，批量删除审核记录 id 为 1 和 2 的两个审核记录，返回的 rjson 格式响应结果如下：

{ "succeed": true}

HEAD 请求

返回跟 GET 请求一样的 HTTP 响应头，但是没有响应实体。可以在不必传输整个响应内容的情况下，获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型，字符编码，压缩编码，实体内容长度等。

HEAD 请求可以用来判断 usersCheckInfos 资源是否存在，或者客户端是否有权限访问 usersCheckInfos 资源。通过对加.<format>的 URI 执行 HEAD 请求，还可以快速判断 usersCheckInfos 资源是否支持<format>格式的表述。

请参见