“角色及权限”的版本间的差异

来自uucall
跳转至： 导航、 搜索
（创建页面，内容为“== 获取角色信息 == == 新增角色信息 == == 获取当前角色可访问应用信息 == == 修改当前角色可访问应用权限 == == 修改某角色信...”）
 
 
（未显示同一用户的2个中间版本）
第1行： 第1行：
 
== 获取角色信息 ==
 
== 获取角色信息 ==
 +
* <big>说明</big>
 +
方法: GET<br />
 +
前缀：http://ip:port/uucall_restapi/rest/<br />
 +
路径: /power/role<br />
 +
参数校验：无
 +
 +
* <big>示例</big>
 +
GET /power/role HTTP/1.1<br />
 +
Host:192.168.2.1:2888<br />
 +
content-length: 139<br />
 +
Accept:application/xml;<br />
 +
Content-Type:application/xml;charset=utf-8;<br />
 +
appid:XXXX<br />
 +
timestamp:2016-03-11 00:00:00<br />
 +
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE<br />
 +
<br />
 +
 +
* <big>参数列表</big>
 +
{| class="wikitable"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 输入参数 || uid || 企业帐号ID || true || Long ||
 +
|-
 +
| 输入参数 || name || 角色名称 || false || string ||
 +
|}
 +
<br />
 +
* <big>结构响应</big>
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data !! Code
 +
|-
 +
| success || list<Role> || 0
 +
|-
 +
| error || sql exception || 4
 +
|-
 +
| error || parameters error || 9
 +
|}
 +
<br />
 +
* <big>返回值格式</big>
 +
application/json<br />
 +
<br />
 +
 
== 新增角色信息 ==
 
== 新增角色信息 ==
 +
* <big>说明</big>
 +
方法: POST<br />
 +
前缀：http://ip:port/uucall_restapi/rest/<br />
 +
路径: /power/role<br />
 +
参数校验：无
 +
 +
* <big>示例</big>
 +
POST /power/role HTTP/1.1<br />
 +
Host:192.168.2.1:2888<br />
 +
content-length: 139<br />
 +
Accept:application/xml;<br />
 +
Content-Type:application/xml;charset=utf-8;<br />
 +
appid:XXXX<br />
 +
timestamp:2016-03-11 00:00:00<br />
 +
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE<br />
 +
<br />
 +
 +
* <big>参数列表</big>
 +
{| class="wikitable"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 输入参数 || uid || 企业帐号ID || true || Long ||
 +
|-
 +
| 输入参数 || name || 角色名称 || false || string ||
 +
|-
 +
| 输入参数 || body || 角色结构体 || false || Role ||
 +
|}
 +
<br />
 +
* <big>结构响应</big>
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || 成功描述
 +
|-
 +
| failed || 失败描述
 +
|}
 +
<br />
 +
* <big>返回值格式</big>
 +
application/json<br />
 +
<br />
 +
 
== 获取当前角色可访问应用信息 ==
 
== 获取当前角色可访问应用信息 ==
 +
* <big>说明</big>
 +
方法: GET<br />
 +
前缀：http://ip:port/uucall_restapi/rest/<br />
 +
路径: /power/role/auth/{roleId}<br />
 +
参数校验：无
 +
 +
* <big>示例</big>
 +
GET /power/role/auth/212 HTTP/1.1<br />
 +
Host:192.168.2.1:2888<br />
 +
content-length: 139<br />
 +
Accept:application/xml;<br />
 +
Content-Type:application/xml;charset=utf-8;<br />
 +
appid:XXXX<br />
 +
timestamp:2016-03-11 00:00:00<br />
 +
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE<br />
 +
<br />
 +
 +
* <big>参数列表</big>
 +
{| class="wikitable"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 输入参数 || uid || 企业帐号ID || true || Long ||
 +
|-
 +
| 输入参数 || roleId || 角色ID || true || string ||
 +
|}
 +
<br />
 +
* <big>结构响应</big>
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || list<CustomApplication>
 +
|-
 +
| failed || 失败描述
 +
|}
 +
<br />
 +
* <big>返回值格式</big>
 +
application/json<br />
 +
<br />
 +
 +
 
== 修改当前角色可访问应用权限 ==
 
== 修改当前角色可访问应用权限 ==
 +
* <big>说明</big>
 +
方法: PUT<br />
 +
前缀：http://ip:port/uucall_restapi/rest/<br />
 +
路径: /power/role/auth/{roleId}<br />
 +
参数校验：无
 +
 +
* <big>示例</big>
 +
PUT /power/role/auth/212 HTTP/1.1<br />
 +
Host:192.168.2.1:2888<br />
 +
content-length: 139<br />
 +
Accept:application/xml;<br />
 +
Content-Type:application/xml;charset=utf-8;<br />
 +
appid:XXXX<br />
 +
timestamp:2016-03-11 00:00:00<br />
 +
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE<br />
 +
<br />
 +
 +
* <big>参数列表</big>
 +
{| class="wikitable"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 输入参数 || roleId || 角色ID || true || string ||
 +
|-
 +
| 输入参数 || authAppIds || 可访问应用ID( 多值以“,”隔开) || false || string ||
 +
|-
 +
| 输入参数 || unAuthAppIds || 不可访问应用ID( 多值以","隔开) || false || string ||
 +
|}
 +
<br />
 +
* <big>结构响应</big>
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || 成功描述
 +
|-
 +
| failed || 失败描述
 +
|}
 +
<br />
 +
* <big>返回值格式</big>
 +
application/json<br />
 +
其中 ivr模板json字符串 形式如下：<br />
 +
<br />
 +
 
== 修改某角色信息 ==
 
== 修改某角色信息 ==
 +
* <big>说明</big>
 +
方法: PUT<br />
 +
前缀：http://ip:port/uucall_restapi/rest/<br />
 +
路径: /power/role/{roleId}<br />
 +
参数校验：无
 +
 +
* <big>示例</big>
 +
PUT /power/role/212 HTTP/1.1<br />
 +
Host:192.168.2.1:2888<br />
 +
content-length: 139<br />
 +
Accept:application/xml;<br />
 +
Content-Type:application/xml;charset=utf-8;<br />
 +
appid:XXXX<br />
 +
timestamp:2016-03-11 00:00:00<br />
 +
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE<br />
 +
<br />
 +
 +
* <big>参数列表</big>
 +
{| class="wikitable"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 输入参数 || uid || 企业帐号ID || true || Long ||
 +
|-
 +
| 输入参数 || roleId || 角色ID || true || string ||
 +
|-
 +
| 输入参数 || body || 角色结构体 || false || Role ||
 +
|}
 +
<br />
 +
* <big>结构响应</big>
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || 成功描述
 +
|-
 +
| failed || 失败描述
 +
|}
 +
<br />
 +
* <big>返回值格式</big>
 +
application/json<br />
 +
其中 ivr模板json字符串 形式如下：<br />
 +
<br />
 +
 
== 删除某角色信息 ==
 
== 删除某角色信息 ==
 +
* <big>说明</big>
 +
方法: DELETE<br />
 +
前缀：http://ip:port/uucall_restapi/rest/<br />
 +
路径: /power/role/{roleId}<br />
 +
参数校验：无
 +
 +
* <big>示例</big>
 +
DELETE /power/role/212 HTTP/1.1<br />
 +
Host:192.168.2.1:2888<br />
 +
content-length: 139<br />
 +
Accept:application/xml;<br />
 +
Content-Type:application/xml;charset=utf-8;<br />
 +
appid:XXXX<br />
 +
timestamp:2016-03-11 00:00:00<br />
 +
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE<br />
 +
<br />
 +
 +
* <big>参数列表</big>
 +
{| class="wikitable"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 输入参数 || name || 角色名称 || false || string || 
 +
|}
 +
<br />
 +
* <big>结构响应</big>
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || 成功描述
 +
|-
 +
| failed || 失败描述
 +
|}
 +
<br />
 +
* <big>返回值格式</big>
 +
application/json<br />
 +
其中 ivr模板json字符串 形式如下：<br />
 +
<br />

2016年4月26日 (二) 21:32的最新版本

获取角色信息

  • 说明
方法: GET

前缀：http://ip:port/uucall_restapi/rest/

路径: /power/role

参数校验：无
  • 示例
GET /power/role HTTP/1.1

Host:192.168.2.1:2888

content-length: 139

Accept:application/xml;

Content-Type:application/xml;charset=utf-8;

appid:XXXX

timestamp:2016-03-11 00:00:00

Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE


  • 参数列表
类型 参数名 描述 是否必填 数据类型 默认值
输入参数 uid 企业帐号ID true Long
输入参数 name 角色名称 false string


  • 结构响应

其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：

Result Data Code
success list<Role> 0
error sql exception 4
error parameters error 9


  • 返回值格式

application/json

新增角色信息

  • 说明
方法: POST

前缀：http://ip:port/uucall_restapi/rest/

路径: /power/role

参数校验：无
  • 示例
POST /power/role HTTP/1.1

Host:192.168.2.1:2888

content-length: 139

Accept:application/xml;

Content-Type:application/xml;charset=utf-8;

appid:XXXX

timestamp:2016-03-11 00:00:00

Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE


  • 参数列表
类型 参数名 描述 是否必填 数据类型 默认值
输入参数 uid 企业帐号ID true Long
输入参数 name 角色名称 false string
输入参数 body 角色结构体 false Role


  • 结构响应

其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：

Result Data
success 成功描述
failed 失败描述


  • 返回值格式

application/json

获取当前角色可访问应用信息

  • 说明
方法: GET

前缀：http://ip:port/uucall_restapi/rest/

路径: /power/role/auth/{roleId}

参数校验：无
  • 示例
GET /power/role/auth/212 HTTP/1.1

Host:192.168.2.1:2888

content-length: 139

Accept:application/xml;

Content-Type:application/xml;charset=utf-8;

appid:XXXX

timestamp:2016-03-11 00:00:00

Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE


  • 参数列表
类型 参数名 描述 是否必填 数据类型 默认值
输入参数 uid 企业帐号ID true Long
输入参数 roleId 角色ID true string


  • 结构响应

其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：

Result Data
success list<CustomApplication>
failed 失败描述


  • 返回值格式

application/json


修改当前角色可访问应用权限

  • 说明
方法: PUT

前缀：http://ip:port/uucall_restapi/rest/

路径: /power/role/auth/{roleId}

参数校验：无
  • 示例
PUT /power/role/auth/212 HTTP/1.1

Host:192.168.2.1:2888

content-length: 139

Accept:application/xml;

Content-Type:application/xml;charset=utf-8;

appid:XXXX

timestamp:2016-03-11 00:00:00

Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE


  • 参数列表
类型 参数名 描述 是否必填 数据类型 默认值
输入参数 roleId 角色ID true string
输入参数 authAppIds 可访问应用ID( 多值以“,”隔开) false string
输入参数 unAuthAppIds 不可访问应用ID( 多值以","隔开) false string


  • 结构响应

其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：

Result Data
success 成功描述
failed 失败描述


  • 返回值格式

application/json
其中 ivr模板json字符串 形式如下：

修改某角色信息

  • 说明
方法: PUT

前缀：http://ip:port/uucall_restapi/rest/

路径: /power/role/{roleId}

参数校验：无
  • 示例
PUT /power/role/212 HTTP/1.1

Host:192.168.2.1:2888

content-length: 139

Accept:application/xml;

Content-Type:application/xml;charset=utf-8;

appid:XXXX

timestamp:2016-03-11 00:00:00

Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE


  • 参数列表
类型 参数名 描述 是否必填 数据类型 默认值
输入参数 uid 企业帐号ID true Long
输入参数 roleId 角色ID true string
输入参数 body 角色结构体 false Role


  • 结构响应

其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：

Result Data
success 成功描述
failed 失败描述


  • 返回值格式

application/json
其中 ivr模板json字符串 形式如下：

删除某角色信息

  • 说明
方法: DELETE

前缀：http://ip:port/uucall_restapi/rest/

路径: /power/role/{roleId}

参数校验：无
  • 示例
DELETE /power/role/212 HTTP/1.1

Host:192.168.2.1:2888

content-length: 139

Accept:application/xml;

Content-Type:application/xml;charset=utf-8;

appid:XXXX

timestamp:2016-03-11 00:00:00

Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE


  • 参数列表
类型 参数名 描述 是否必填 数据类型 默认值
输入参数 name 角色名称 false string


  • 结构响应

其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：

Result Data
success 成功描述
failed 失败描述


  • 返回值格式

application/json
其中 ivr模板json字符串 形式如下：

取自“http://112.5.128.48:9988/index.php?title=角色及权限&oldid=286”