URI

<departments_uri>/{departmentId}[.<format>]

支持的方法

GET、PUT、HEAD

父资源

departments

子资源

departmentAdmins、departmentMembers、departmentName、moveDepartment

介绍

department 资源是组织结构中单个部门的列表信息，通过发送 PUT 请求，可以编辑单个部门的属性信息。

支持的方法：

  • GET：获取单个部门的列表信息。
  • PUT：编辑单个部门的属性信息。
  • HEAD：检查 department 资源是否存在，或权限是否可以访问 department 资源。

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

资源层次

HTTP 请求方法

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

http://supermapiportal:8190/iportal/manager/iportalconfig/departments/{departmentId}.rjson

GET 请求

获取单个部门的列表信息。

响应结构

对 department 资源执行 GET 请求，返回门户中单个部门的列表信息，由以下字段组成：

字段 类型 说明
childIds String 部门的下一级部门的 id 列表。
createTime long 部门创建时间。
id Integer 部门的 id 标识。
name String 部门的名称。
orderNum Integer 部门的序号，可用于部门排序。
parentId Integer 部门的上一级部门 id。

响应示例

对 department 资源：http://localhost:8190/iportal/manager/iportalconfig/departments/1.rjson 执行 GET 请求，获取门户中单个部门的列表信息，返回 rjson 格式的资源表述如下：

{

    "childIds": "2,3",

    "createTime": 1487663320292,

    "id": 1,

    "name": "A市环保局",

    "orderNum": 1,

    "parentId": null

}

PUT 请求

编辑单个部门的属性信息。

响应结构

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

字段 类型 说明
succeed boolean 编辑部门属性信息是否成功。
error Httperror 出错信息，如果编辑部门属性信息成功，则没有本字段。

响应示例

对 department 资源：http://localhost:8190/iportal/manager/iportalconfig/departments/1.rjson 执行 PUT 请求，编辑部门的属性信息，发送请求体如下：

{

    "name": "A市环保局",

    "orderNum": 10

}

则返回的 rjson 格式的资源表述如下：

{"succeed": true}

HEAD 请求

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

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

请参见