页面树结构
转至元数据结尾
转至元数据起始


1、组织管理接口

  • 主要包含企业下组织的管理接口
    • 添加组织

    • 获取组织

    • 更新组织

    • 删除组织

    • 获取组织列表

    • 更新成员所属组织

    • 获取组织下成员

1.1、添加组织

  • 添加组织,企业成员、大客户用于为企业添加一个下属组织
  • 参数主要为组织名称name,组织描述desc以及父组织标识parent_id

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/organization

Method

POST

Header

Content-Type
"application/json"
Access-Token

企业调用凭证/大客户

Body

字段

选项

类型

说明

name

必选

string

组织名称, 2-20个字符

desc必须string组织描述, 2-100个字符

parent_id

可选

string

父组织标识

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

id

必选

string

组织标识

name

必选

string

组织名称, 2-32个字符

type必选int组织类型, 1:成员组织, 2:大客户组织

desc

必选

string

组织描述, 2-100个字符部门描述

parent_id必选string父组织标识

create_time

必选

string

组织创建时间, 格式为yyyy-MM-dd'T'HH:mm:ss.SS'Z'

heavy_buyer_id

可选

string

大客户标识, 在type=2时存在

1.2、获取组织

  • 获取组织,企业成员、大客户用于获取组织信息
  • 参数为组织标识organization_id

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/organization/{organization_id}

字段

选项类型说明
{organization_id}必选string企业下组织标识

Method

GET

Header

Content-Type
"application/json"
Access-Token

企业调用凭证/大客户

Body

字段

选项

类型

说明

--

--

--

--

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

id

必选

string

组织标识

name

必选

string

组织名称, 2-32个字符

type必选int组织类型, 1:成员组织, 2:大客户组织

desc

必选

string

组织描述, 2-100个字符部门描述

parent_id必选string父组织标识

create_time

必选

string

组织创建时间, 格式为yyyy-MM-dd'T'HH:mm:ss.SS'Z'

heavy_buyer_id

可选

string

大客户标识, 在type=2时存在

1.3、更新组织

  • 更新组织,企业成员、大客户用于修改组织属性
  • 参数主要为组织标识organization_id,组织名称name,组织描述desc以及父组织标识parent_id

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/organization/{organization_id}

字段

选项类型说明
{organization_id}必选string企业下组织标识

Method

PUT

Header

Content-Type
"application/json"
Access-Token

企业调用凭证/大客户

Body

字段

选项

类型

说明

name

必选

string

组织名称

desc可选string组织描述
parent_id可选string父组织标识

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

id

必选

string

组织标识

name

必选

string

组织名称, 2-32个字符

type必选int组织类型, 1:成员组织, 2:大客户组织

desc

必选

string

组织描述, 2-100个字符部门描述

parent_id必选string父组织标识

create_time

必选

string

组织创建时间, 格式为yyyy-MM-dd'T'HH:mm:ss.SS'Z'

heavy_buyer_id

可选

string

大客户标识, 在type=2时存在

1.4、删除组织

  • 删除部门,企业成员、大客户用于删除组织信息
  • 参数为组织标识organization_id
  • 删除部门同时删除下属岗位
  • 权限为级别为CORP、HEAVY_BUYER、DEALER

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/organization/{organization_id}

字段

选项

类型

说明

organization_id

必选

string

企业下组织标识

Method

DELETE

Header

Content-Type
"application/json"
Access-Token

企业调用凭证/大客户

Body

字段

选项

类型

说明

--

--

--

--

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

--

--

--

--

1.5、获取组织列表

  • 获取组织列表,企业成员、大客户用于获取组织列表信息
  • 参数为组织标识organization_id,组织名称name,组织描述desc以及父组织标识parent_id
  • {
        "offset" : "请求列表的偏移量",
        "limit" : "请求数量",
        "filter" : ["字段A", "字段B"],
        "query" :
        {
            "filed1" : {"$in" : ["字段值", "字段值"]},
            "filed2" : {"$lt" : "字段值"}
        },
        "order" :
        {
            "filed1" : 1,
            "filed2" : -1
        }
    }
  • query支持条件操作符
    • $eq
    • $lt
    • $nin
    • $lt
    • $lte
    • $gt
    • $gte
    • $ne
    • $like
    • $all

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/organizations

Method

POST

Header

Content-Type
"application/json"
Access-Token

企业调用凭证/大客户

Body

字段

选项

类型

说明

offset

可选

int

请求偏移量, 默认为0

limit可选int请求量, 默认为10
query可选object请求条件
filter可选array需要返回字段列表
order可选object排序条件

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

id

必选

string

组织标识

name

必选

string

组织名称, 2-32个字符

type必选int组织类型, 1:成员组织, 2:大客户组织

desc

必选

string

组织描述, 2-100个字符部门描述

parent_id必选string父组织标识

create_time

必选

string

组织创建时间, 格式为yyyy-MM-dd'T'HH:mm:ss.SS'Z'

heavy_buyer_id

可选

string

大客户标识, 在type=2时存在

1.6、更新成员所属组织

  • 更新成员所属组织,企业成员用于更新成员组织信息
  • 参数为成员标识member_id,操作类型opt,组织数组org_ids

接口

权限

平台账号

请求

URL

https://{xlink_host} /v2/corp/member/{member_id}/organization

字段

选项类型说明
{member_id}必选string企业成员id

Method

PUT

Header

Content-Type
"application/json"
Access-Token

企业调用凭证

Body

字段

选项

类型

说明

opt

必选

int

操作类型, 1:新增, 2:删除, 3:覆盖

org_ids必选array组织iD数值

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

--

--

--

--

1.7、获取组织下成员

  • 获取组织下成员列表,企业成员用于获取组织列表信息
  • 参数为组织标识organization_id
  • {
        "offset" : "请求列表的偏移量",
        "limit" : "请求数量",
        "filter" : ["字段A", "字段B"],
        "query" :
        {
            "filed1" : {"$in" : ["字段值", "字段值"]},
            "filed2" : {"$lt" : "字段值"}
        },
        "order" :
        {
            "filed1" : 1,
            "filed2" : -1
        }
    }
  • query支持条件操作符
    • $eq
    • $lt
    • $nin
    • $lt
    • $lte
    • $gt
    • $gte
    • $ne
    • $like
    • $all

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/organization/{organization_ids}/members

字段选项类型说明
organization_ids

必选

string企业组织id

Method

POST

Header

Content-Type
"application/json"
Access-Token

企业调用凭证

Body

字段

选项

类型

说明

offset

可选

int

请求偏移量, 默认为0

limit可选int请求量, 默认为10
query可选object请求条件
filter可选array需要返回字段列表
order可选object排序条件

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

id

必选

string

成员 ID

name

必选

string

成员姓名

role_ids 必选string拥有的角色id集合

phone 

必选

string

组织描述, 2-100个字符部门描述

email 必选string父组织标识

create_time

必选

string

创建时间, 格式为yyyy-MM-dd'T'HH:mm:ss.SS'Z'

last_auth_time 必选string最近认证时间,例:2014-10-09T08:15:40.843Z
is_notice 必选int是否接受通知
is_alert 必选int是否接受告警

status 

必选

string

成员状态,见[附录](#member_status)

2、部门管理接口

  • 主要包含组织下部门的管理接口
    • 增加部门
    • 修改部门
    • 获取部门
    • 删除部门
    • 部门列表

2.1、增加部门

  • 添加部门,企业成员、大客户、经销商用于为组织添加一个下属部门
  • 参数主要为组织标识organization_id,部门名称name,部门描述desc

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/organization/{organization_id}/department

字段

选项

类型

说明

organization_id

必选

string

企业下组织标识

Method

POST

Header

Content-Type
"application/json"
Access-Token

企业调用凭证/大客户/经销商

Body

字段

选项

类型

说明

name

必选

string

区域名称,长度1-32

desc

可选

string

区域描述,长度0-64

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

id

必选

string

部门标识

name

必选

string

部门名称

desc

必选

string

部门描述

create_time

必选

string

部门创建时间, 格式为yyyy-MM-dd'T'HH:mm:ss.SS'Z'

organization_id

必选

string

部门所属组织标识

2.2、修改部门

  • 修改部门,企业成员、大客户、经销商用于修改部门属性
  • 参数主要为组织标识organization_id,部门标识department_id,部门名称name,部门描述desc

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/organization/{organization_id}/department/{department_id}

字段

选项

类型

说明

organization_id

必选

string

企业下组织标识

department_id

必选

string

企业部门标识

Method

PUT

Header

Content-Type
"application/json"
Access-Token

企业调用凭证/大客户/经销商

Body

字段

选项

类型

说明

name

可选

string

区域名称,长度1-32

desc

可选

string

区域描述,长度0-64

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

id

必选

string

部门标识

name

必选

string

部门名称

desc

必选

string

部门描述

create_time

必选

string

部门创建时间, 格式为yyyy-MM-dd'T'HH:mm:ss.SS'Z'

organization_id

必选

string

部门所属组织标识

2.3、获取部门

  • 获取部门,企业成员、大客户、经销商用于获取部门信息
  • 参数为组织标识organization_id,部门标识department_id

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/organization/{organization_id}/department/{department_id}

字段

选项

类型

说明

organization_id

必选

string

企业下组织标识

department_id

必选

string

企业部门标识

Method

GET

Header

Content-Type
"application/json"
Access-Token

企业调用凭证/大客户/经销商

Body

字段

选项

类型

说明

--

--

--

--

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

id

必选

string

部门标识

name

必选

string

部门名称

desc

必选

string

部门描述

create_time

必选

string

部门创建时间, 格式为yyyy-MM-dd'T'HH:mm:ss.SS'Z'

organization_id

必选

string

部门所属组织标识

2.4、删除部门

  • 删除部门,企业成员、大客户、经销商用于删除部门信息
  • 参数为组织标识organization_id,部门标识department_id
  • 删除部门同时删除下属岗位

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/organization/{organization_id}/department/{department_id}

字段

选项

类型

说明

organization_id

必选

string

企业下组织标识

department_id

必选

string

企业部门标识

Method

DELETE

Header

Content-Type
"application/json"
Access-Token

企业调用凭证/大客户/经销商

Body

字段

选项

类型

说明

--

--

--

--

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

--

--

--

--

2.5、获取部门列表

  • 获取部门列表,企业成员、大客户、经销商用于获取部门列表信息
  • 参数为组织标识organization_id,部门标识department_id,部门名称name,部门描述desc
  • {
        "offset" : "请求列表的偏移量",
        "limit" : "请求数量",
        "filter" : ["字段A", "字段B"],
        "query" :
        {
            "filed1" : {"$in" : ["字段值", "字段值"]},
            "filed2" : {"$lt" : "字段值"}
        },
        "order" :
        {
            "filed1" : 1,
            "filed2" : -1
        }
    }
  • query支持条件操作符
    • $eq
    • $lt
    • $nin
    • $lt
    • $lte
    • $gt
    • $gte
    • $ne
    • $like
    • $all

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/departments

字段

选项

类型

说明

--

--

--

--

Method

POST

Header

Content-Type
"application/json"
Access-Token

企业调用凭证/大客户/经销商

Body

字段

选项

类型

说明

offset

可选

int

请求偏移量, 默认为0

limit

可选

int

请求量, 默认为10

query

可选

object

请求条件

query.name

可选

object

部门名称查询条件,支持平台所有操作符

query.desc

可选

object

部门描述查询条件,支持平台所有操作符

filter

可选

array

需要返回字段列表

order

可选

object

排序条件

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

count

必选

int

部门列表总数

list

必须

array

部门列表

list.id

可选

string

部门标识,根据filter是否有要求返回

list.name

可选

string

部门名称,根据filter是否有要求返回

list.desc

可选

string

部门描述,根据filter是否有要求返回

list.create_time

可选

string

部门创建时间,,根据filter是否有要求返回格式为yyyy-MM-dd'T'HH:mm:ss.SS'Z'

list.organization_id

可选

string

部门所属组织标识,根据filter是否有要求返回


3、岗位管理接口

主要包含组织下部门下岗位的管理接口

  • 增加岗位
  • 修改岗位
  • 获取岗位
  • 删除岗位
  • 岗位列表
  • 为企业成员关联岗位
  • 为大客户用户关联岗位
  • 为经销用户关联岗位

3.1、增加岗位

  • 增加岗位,企业成员、大客户、经销商用于增加岗位信息
  • 参数为组织标识organization_id,部门标识department_id

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/organization/{organization_id}/department/{department_id}/position

字段

选项

类型

说明

organization_id

必选

string

企业下组织标识

department_id

必选

string

企业部门标识

Method

POST

Header

Content-Type
"application/json"
Access-Token

企业调用凭证/大客户/经销商

Body

字段

选项

类型

说明

name

必选

string

岗位名称,长度1-32

desc

可选

string

岗位描述,长度0-64

role_ids

可选

array

岗位拥有角色标识集合,必须对应拥有的角色

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

id

必选

string

岗位标识

name

必选

string

岗位名称

desc

必选

string

岗位描述

create_time

必选

string

岗位创建时间, 格式为yyyy-MM-dd'T'HH:mm:ss.SS'Z'

organization_id

必选

string

岗位所属组织标识

department_id

必选

string

岗位所属部门标识

role_ids

必选

array

岗位拥有角色集合名称

3.2、修改岗位

  • 修改岗位,企业成员、大客户、经销商用于修改岗位信息
  • 参数为组织标识organization_id,部门标识department_id,岗位标识position_id,岗位名称name,岗位描述desc,岗位拥有角色role_id_list

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/organization/{organization_id}/department/{department_id}/position/{position_id}

字段

选项

类型

说明

organization_id

必选

string

企业下组织标识

department_id

必选

string

企业部门标识

Method

PUT

Header

Content-Type
"application/json"
Access-Token

企业调用凭证/大客户/经销商

Body

字段

选项

类型

说明

name

可选

string

岗位名称,长度1-32

desc

可选

string

岗位描述,长度0-64

role_ids

可选

array

岗位拥有角色标识集合,必须对应拥有的角色

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

id

必选

string

岗位标识

name

必选

string

岗位名称

desc

必选

string

岗位描述

create_time

必选

string

岗位创建时间, 格式为yyyy-MM-dd'T'HH:mm:ss.SS'Z'

organization_id

必选

string

岗位所属组织标识

department_id

必选

string

岗位所属部门标识

role_ids

必选

array

岗位拥有角色集合名称

3.3、获取岗位

  • 获取岗位,企业成员、大客户、经销商用于获取岗位信息
  • 参数为组织标识organization_id,部门标识department_id,岗位标识position_id

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/organization/{organization_id}/department/{department_id}/position/{position_id}

字段

选项

类型

说明

organization_id

必选

string

企业下组织标识

department_id

必选

string

企业部门标识

Method

GET

Header

Content-Type
"application/json"
Access-Token

企业调用凭证/大客户/经销商

Body

字段

选项

类型

说明

--

--

--

--

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

id

必选

string

岗位标识

name

必选

string

岗位名称

desc

必选

string

岗位描述

create_time

必选

string

岗位创建时间, 格式为yyyy-MM-dd'T'HH:mm:ss.SS'Z'

organization_id

必选

string

岗位所属组织标识

department_id

必选

string

岗位所属部门标识

role_ids

必选

array

岗位拥有角色集合名称

3.4、删除岗位

  • 删除岗位,企业成员、大客户、经销商用于删除岗位信息
  • 参数为组织标识organization_id,部门标识department_id,岗位标识position_id

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/organization/{organization_id}/department/{department_id}/position/{position_id}

字段

选项

类型

说明

organization_id

必选

string

企业下组织标识

department_id

必选

string

企业部门标识

Method

DELETE

Header

Content-Type
"application/json"
Access-Token

企业调用凭证/大客户/经销商

Body

字段

选项

类型

说明

--

--

--

--

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

--

--

--

--

3.5、岗位列表

  • 获取岗位列表,企业成员、大客户、经销商用于获取岗位列表信息
  • 参数为组织标识organization_id,部门标识department_id,岗位标识position_id,岗位名称name,岗位描述desc
  • {
        "offset" : "请求列表的偏移量",
        "limit" : "请求数量",
        "filter" : ["字段A", "字段B"],
        "query" :
        {
            "filed1" : {"$in" : ["字段值", "字段值"]},
            "filed2" : {"$lt" : "字段值"}
        },
        "order" :
        {
            "filed1" : 1,
            "filed2" : -1
        }
    }
  • query支持条件操作符
    • $eq
    • $lt
    • $nin
    • $lt
    • $lte
    • $gt
    • $gte
    • $ne
    • $like
    • $all

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/positions

字段

选项

类型

说明

--

--

--

--

Method

POST

Header

Content-Type
"application/json"
Access-Token

企业调用凭证/大客户/经销商

Body

字段

选项

类型

说明

offset

可选

int

请求偏移量, 默认为0

limit

可选

int

请求量, 默认为10

query

可选

object

请求条件

query.name

可选

object

岗位名称查询条件,支持平台所有操作符

query.desc

可选

object

岗位描述查询条件,支持平台所有操作符

filter

可选

array

需要返回字段列表

order

可选

object

排序条件

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

count

必选

int

岗位列表总数

list

必须

array

岗位列表

list.id

可选

string

岗位标识,根据filter是否有要求返回

list.name

可选

string

岗位名称,根据filter是否有要求返回

list.desc

可选

string

岗位描述,根据filter是否有要求返回

list.create_time

可选

string

岗位创建时间,,根据filter是否有要求返回格式为yyyy-MM-dd'T'HH:mm:ss.SS'Z'

list.organization_id

可选

string

岗位所属组织标识,根据filter是否有要求返回

list.department_id

可选

string

岗位所属部门标识,根据filter是否有要求返回

list.role_ids

可选

array

岗位拥有角色标识,根据filter是否有要求返回

list.numbers

可选

int

成员数

3.6、为企业成员关联岗位

  • 企业成员为企业成员关联岗位
  • 参数为成员member_id,岗位标识position_id列表

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/member/{member_id}/position

字段

选项

类型

说明

member_id

必选

string

企业下成员标识

Method

PUT

Header

Content-Type
"application/json"
Access-Token

企业调用凭证

Body

字段

选项

类型

说明

position_ids

可选

array

企业成员关联的岗位标识列表

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

--

--

--

--

3.7、为大客户用户关联岗位

  • 大客户成员为大客户成员关联岗位
  • 参数为大客户用户标识heavy_buyer_user_id,岗位标识position_id列表

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/corp/heavybuyer/{heavy_buyer_user_id}/position

字段

选项

类型

说明

heavy_buyer_user_id

必选

string

企业下大客户用户标识

Method

PUT

Header

Content-Type
"application/json"
Access-Token

大客户调用凭证

Body

字段

选项

类型

说明

position_ids

可选

array

企业大客户用户关联的岗位标识列表

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

--

--

--

--

3.8、为经销用户关联岗位

  • 经销商成员为经销商成员关联岗位
  • 参数为经销商标识dealer_id,经销商用户标识dealer_user_id,岗位标识position_id列表

接口

权限

平台账号

请求

URL

https://{xlink_host}/v2/dealer/{dealer_id}/user/{dealer_user_id}/position

字段

选项

类型

说明

dealer_id

必选

string

企业下经销商标识

dealer_user_id

必选

string

企业下经销商用户标识

Method

PUT

Header

Content-Type
"application/json"
Access-Token

经销商调用凭证

Body

字段

选项

类型

说明

position_ids

可选

array

企业经销商用户关联的岗位标识列表

响应

Header

HTTP/1.1 200 OK

Content


字段

选项

类型

说明

--

--

--

--

附录

成员状态

枚举值说明
0待激活
1正常可用
2停用

  • 无标签