URI

<portal_uri>/users[.<format>]

支持的方法

POST、HEAD

父资源

portal

子资源

user、usersCheckInfos、isRegistered、isNickRegistered

介绍

用户列表。支持注册新用户。

支持的方法：

  • POST：注册新用户。
  • HEAD：检查 users 资源是否存在，或权限是否可以访问 users 资源。

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

资源层次

HTTP 请求方法

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

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

POST 请求

注册新用户。

请求参数

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

名称 类型 含义
name String 【必选参数】 账号。
nickname String 【可选参数】 昵称。如果 nickname 为空，系统会默认将昵称设置为与账号同名。
password String 【必选参数】 密码。
departmentId Integer 【可选参数】 部门 id 标识。
email String 【可选参数】 邮箱地址。
passwordQuestion IportalPasswordQuestion 【可选参数】 用于重置密码的安全性问题和答案。

响应结构

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

字段 类型 说明
succeed boolean 注册新用户是否成功。
error Httperror 出错信息，如果注册新用户成功，则没有本字段。

响应示例

对 users 资源:http://localhost:8190/iportal/web/users.rjson 执行 POST 请求，发送请求体如下：

{

    "name": "user6",

    "nickname": "user6",

    "password": "iserver`12",

    "departmentId": "3",

    "email": "user6@rdc.supermap.com",

    "passwordQuestion": {

        "pwdQuestion": "school",

        "pwdAnswer": "仓中"

    }

}

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

{"succeed": true}

 

HEAD 请求

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

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

请参见