查询虚拟机构详情
使用场景: 查询虚拟机构详细信息
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 仅租户管理员 |
机构凭证 | 未支持 | - |
请求方式:POST (HTTPS)
请求地址:https://test-oapi.epaas.qq.com/virtual_corp/get?access_token=ACCESS_TOKEN
{
"corpid": 1
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 用户token |
corpid | 是 | 机构id |
返回结果:
{
"corpid": 1,
"name": "腾讯"
}
参数说明:
参数 | 说明 |
---|---|
corpid | 机构id |
name | 机构名字 |
批量查询虚拟机构详情
使用场景: 批量查询虚拟机构详细信息
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 仅租户管理员 |
机构凭证 | 未支持 | - |
请求方式:POST (HTTPS)
请求地址:https://test-oapi.epaas.qq.com/virtual_corp/batch_get?access_token=ACCESS_TOKEN
{
"corpids":[1098609]
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 用户token |
corpids | 是 | 机构id列表 |
返回结果:
{
"data_list": [
{
"corpid": 1098609,
"name": "勿删虚拟机构"
}
]
}
参数说明:
参数 | 说明 |
---|---|
data_list | 数组 |
data_list.corpid | 机构id |
data_list.name | 机构名字 |
创建虚拟机构
使用场景: 创建虚拟机构
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 仅租户管理员 |
机构凭证 | 未支持 | - |
请求方式:POST (HTTPS)
请求地址:https://test-oapi.epaas.qq.com/virtual_corp/create?access_token=ACCESS_TOKEN
{
"name": "腾讯"
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 用户token |
name | 是 | 机构名字,不能重复 |
返回结果:
{
"corpid": 1
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
corpid | 机构ID |
更新虚拟机构
使用场景: 更新虚拟机构
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 仅租户管理员 |
机构凭证 | 未支持 | - |
请求方式:POST (HTTPS)
请求地址:https://test-oapi.epaas.qq.com/virtual_corp/update?access_token=ACCESS_TOKEN
{
"corpid": 1,
"name": "腾讯"
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 用户token |
corpid | 是 | 机构id |
name | 是 | 机构名字,不能重复 |
返回结果:
{
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
删除虚拟机构
使用场景: 更新虚拟机构
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 仅租户管理员 |
机构凭证 | 未支持 | - |
请求方式:POST (HTTPS)
请求地址:https://test-oapi.epaas.qq.com/virtual_corp/delete?access_token=ACCESS_TOKEN
{
"corpid": 1
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 用户token |
corpid | 是 | 机构id |
返回结果:
{
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
虚拟机构转学校
使用场景: 虚拟机构转学校
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 仅租户管理员 |
机构凭证 | 未支持 | - |
请求方式:POST (HTTPS)
请求地址:https://test-oapi.epaas.qq.com/virtual_corp/to_school?access_token=ACCESS_TOKEN
{
"corpid": 1,
"name": "腾讯",
"full_name": "学校全称",
"code": "xxxx",
"address": {
"country_id": 312829,
"province_id": 1,
"city_id": 3118,
"area_id": 311413,
"detail_address": "湖南省长沙市岳麓区梅西湖路"
},
"school_type": 1,
"creator_info": {
"name": "腾讯",
"email": "xxx@tencent.com",
"duty": "校长",
"mobile": "18692234433"
},
"school_categories": "1,2,3",
"extend_profile": "{\"FieldA\": 01,\"FieldB\": 02,\"FieldC\": 99}"
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 用户调用接口凭证 |
corpid | 是 | 虚拟机构Id |
name | 是 | 机构名字 |
full_name | 否 | 机构全称 |
code | 是 | 机构编码 |
address.country_id | 是 | 国家ID |
address.province_id | 是 | 省份ID |
address.city_id | 是 | 城市ID |
address.area_id | 是 | 区/县Id |
address.detail_address | 是 | 机构详细地址 |
school_categories | 是 | 学校类型,参数值含义参考《学校类型对照表》,逗号分隔 |
school_type | 否 | 1 公办 2 民办;默认公办 |
creator_info.name | 是 | 联系人名字 |
creator_info.duty | 否 | 创建人职务 |
creator_info.mobile | 是 | 创建人联系电话 |
creator_info.email | 否 | 创建人邮箱 |
extend_profile | 否 | 应用托管资料 |
返回结果:
{
}
虚拟机构转行政单位
使用场景: 虚拟机构转行政单位
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 仅租户管理员 |
机构凭证 | 未支持 | - |
请求方式:POST (HTTPS)
请求地址:https://test-oapi.epaas.qq.com/virtual_corp/to_office?access_token=ACCESS_TOKEN
{
"corpid": 1,
"address": {
"country_id": 312829,
"province_id": 1,
"city_id": 3118,
"area_id": 311413,
"detail_address": "湖南省长沙市岳麓区梅西湖路"
},
"name": "腾讯",
"full_name": "教育局全称",
"code": "xxxx",
"level": 1,
"creator_info": {
"name": "腾讯",
"mobile": "18692234433"
},
"extend_profile": "{\"FieldA\": 01,\"FieldB\": 02,\"FieldC\": 99}"
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 用户调用接口凭证 |
corpid | 是 | 虚拟机构Id |
name | 是 | 行政单位名字 |
full_name | 否 | 行政单位全称 |
code | 是 | 机构编码 |
address.country_id | 是 | 国家ID |
address.province_id | 是 | 省份ID |
address.city_id | 是 | 城市ID |
address.area_id | 是 | 区/县ID |
address.detail_address | 是 | 机构详细地址 |
level | 否 | 机构级别 1 国家 2 省/市辖区 3 地市级 4 区/县;默认区/县 |
creator_info.name | 是 | 创建人姓名 |
creator_info.mobile | 是 | 创建人联系电话 |
extend_profile | 否 | 应用托管资料 |
备注:省、市、区等创建后,暂不支持修改,创建时,请谨慎选择
返回结果:
{
}