NAV
json

OMS API文档

oms-api是为集微网OMS管理平台系统所工作的一套API服务。

新版文档收录2021年之后的API内容,之前旧版内容将会逐步迁移。

新版文档支持:

  1. 中文搜索
  2. 语言高亮代码块
  3. Markdown文件同步

旧版文档

接口调用的参数格式

目前接口部分使用 HTTPBody 来进行参数传递,接口支持 application/jsonBody 格式

同时也支持 application/x-www-form-urlencoded 的 Body 格式 ,使用前需要在 Header 中注明 内容类型字段。

请勿使用from-data

鉴权

API 系统的鉴权分为两步:

1.第一步获取鉴权Token

大部分api 所使用的鉴权 Token 来自获取接口鉴权 的access/token 接口 返回

2.第二步获取的Token 去调用其他的接口

接口使用的是基于 rfc6750Bearer Token 鉴权

我们的Bearer Token 使用的是 JWT,在实际业务中并不需要每次调用接口前都去获取Token,在Token的有效期内可以直接用现有的Token进行接口调用,目前我们的Token 有效期为1小时。

!!!注意:需要随时监测返回响应的 Header 中的 Authorization 属性, 若响应返回新的 token 需要清除旧的Toekn 来做到刷新token。

接口返回

第一层 http code返回码,目前常见返回码如下

Http code 说明
200 调用成功
400 调用失败,返回自定义错误
401 鉴权失败
403 权限不足,没有调用权限
500 服务器本身出错

第二层 接口返回内容中的status和error字段

对于status,我们有如下规定

status 说明
100 请求体错误,如请求体格式不对此错误一般伴随http 400 返回码
101 请求体错误,如缺少必要的请求参数、参数不合法,此错误一般伴随http 400 返回码
110 所请求的接口对于所携带的token其所属用户来说权限不足,此错误一般伴随http 403 返回码
111 所请求的接口使用了权限控制,但未在系统中登记权限路由名称,此错误一般伴随http 403 返回码
112 所请求的接口使用了权限控制,但未在系统中登记权限路由所属角色关联,此错误一般伴随http 403 返回码

error

为一个字符串字段,会给出status的具体错误原因描述,这个字段适用于程序开发中的错误调试,不应该把他的返回内容作为代码逻辑判断的条件。也不应直接在前端页面显示。

分页

可以分页的接口在第二次中同时会返回分页所需的字段。

status 说明
current_page 当前页面页码
last_page 最后一页页码
total 该资源的全部数量

接口地址说明

http https
线下 47.112.148.159:8681 https://devoms.laoyaoba.com
预发布 http://omspreview.laoyaoba.com/
正式 http://oms.laoyaoba.com/

所有的接口统一路由前缀为 /api 如 “47.112.148.159:8681/api/access/token” 。

jwt鉴权 token

获取接口鉴权JWT令牌

用户在使用其他接口时,需要携带JWT授权令牌来进行请求,这个接口根据提供的账户和密码,验证,通过后可以返回这个用户可以使用的鉴权JWT令牌。

接口地址

/access/token

请求方式

POST

请求参数

参数 类型 说明
account string 用户账号
password string 用户密码

请求示例

{
    "account": "user@163.com",
    "password": "123456"
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
token string token字符串
token_method string 加密方式
token_type string token 的类型,目前应该固定为 Bearer
expire_time int 过期时间
last_login int 上次用户登录的时间

Token 的 Payload 部分可以使用 base64 反向解密获取信息

返回示例

{
    "status": 0,
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6ImFkbWluIn0.eyJyb2xlIjpbMSwyXSwibmlja25hbWUiOiJcdTk2NzZcdTZkMDEiLCJpZCI6Ik1RPT0iLCJpc3MiOiJhZG1pbkJhc2UiLCJzdWIiOiJhZG1pbkFwaUFjY2VzcyIsImlhdCI6MTU3MzExNjMzOCwiZXhwIjoxNTczMTE5OTM4fQ.N7cKjnje3-16wpqbELpvAkNxKbsSEVRwgXpT-pGw1NI",
    "token_method": "HS256",
    "token_type": "Bearer",
    "expire_time": 1573119938
    "last_login": 1573111002
}

Status返回值

Api code 说明
201 账号密码错误
202 账户已经被封禁

管理员 manager

修改一个管理员的信息

可以使用这个接口更新某一个管理员用户的信息 (仅针对不敏感的内容)不可以修改密码~

接口地址

/admin/manager/{id}

请求方式

put

请求参数

参数 类型 说明 必填
nickname string 名字
department string 部门
position string 职位
overview string 简介
active_status bool 激活状态
role_list array 角色列表

请求示例

{
    "role_list": [10,14]
}
//单独修改激活状态
{
    "active_status": true
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 管理员(Manager:Object)对象

Manager:Object 管理员

参数 类型 说明
id int
account string 账号(唯一)
name string 名字
department string 部门
position string 职位
overview string 简介
active_status bool 启用状态
user_role array 角色(Role:Object)列表
updated_time int 更新时间
created_time int 创建时间

Role:Object 权限

参数 类型 说明
role_id int
role_name string 角色明名
role_label string 注释标签
created_time int 创建时间

返回示例

{
    "status": 0,
    "data": {
        "id": 10,
        "account": "y8ut@163.com",
        "name": "测试账号1",
        "department": "",
        "position": "系统测试",
        "overview": "",
        "active_status": false,
        "user_role": [
            {
                "role_id": 10,
                "role_name": "ADMIN_ROLE_MANAGER",
                "role_label": "权限角色管理",
                "created_time": 1573205350
            },
            {
                "role_id": 14,
                "role_name": "ADMIN_USER_MANAGER",
                "role_label": "系统用户管理",
                "created_time": 1573545074
            }
        ],
        "created_time": 1573528721,
        "updated_time": 1573530789
    }
}

Status返回值

状态码 原因
201 传ID格式不正确
202 找不到选定角色
203 数据库错误

新增一个管理员账户

可以使用这个接口注册新的管理员账户

接口地址

/admin/manager

请求方式

POST

请求参数

参数 类型 说明 必填
account string 账号
nickname string 名字
password string 密码
department string 部门
position string 职位
overview string 简介
role_list array 角色列表

注意!!! 用户的菜单显示是由角色的顺序而定的!

请求示例

{
    "account":"y8ut@163.com",
    "name":"测试账号1",
    "department":"",
    "position":"系统测试",
    "overview":"",
    "user_role":[10,14]
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 管理员(AdminUser:Object)对象

AdminUser:Object 管理员

参数 类型 说明
id int
account string 账号(唯一)
name string 名字
department string 部门
position string 职位
overview string 简介
active_status bool 启用状态
user_role array 角色(Role:Object)列表
updated_time int 更新时间
created_time int 创建时间

Role:Object 权限

参数 类型 说明
role_id int
role_name string 角色明名
role_label string 注释标签
created_time int 创建时间

返回示例

{
    "status": 0,
    "data": {
        "id": 10,
        "account": "y8ut@163.com",
        "name": "测试账号1",
        "department": "",
        "position": "系统测试",
        "overview": "",
        "active_status": false,
        "user_role": [
            {
                "role_id": 10,
                "role_name": "ADMIN_ROLE_MANAGER",
                "role_label": "权限角色管理",
                "created_time": 1573205350
            },
            {
                "role_id": 14,
                "role_name": "ADMIN_USER_MANAGER",
                "role_label": "系统用户管理",
                "created_time": 1573545074
            }
        ],
        "created_time": 1573528721,
        "updated_time": 1573530789
    }
}

Status返回值

状态码 原因
201 传入role ID格式不正确
202 名字重复
203 数据库错误

添加新的管理员账户

可以使用这个接口获取某一个管理员用户的信息

接口地址

/admin/manager/{id}

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 管理员(Manager:Object)对象

Manager:Object 管理员

参数 类型 说明
id int
account string 账号(唯一)
name string 名字
department string 部门
position string 职位
overview string 简介
active_status bool 启用状态
user_role array 角色(Role:Object)列表
user_permissions array Permission:Object 权限列表
updated_time int 更新时间
created_time int 创建时间

Role:Object 权限

参数 类型 说明
role_id int
role_name string 角色明名
role_label string 注释标签
created_time int 创建时间

Permission:Object 权限

参数 类型 说明
id int
permission_name string 权限名名
permission_label string 注释标签
created_time int 创建时间

返回示例

{
    "status": 0,
    "data": {
        "id": 10,
        "account": "y8ut@163.com",
        "name": "测试账号1",
        "department": "",
        "position": "系统测试",
        "overview": "",
        "active_status": false,
        "user_role": [
            {
                "role_id": 10,
                "role_name": "ADMIN_ROLE_MANAGER",
                "role_label": "权限角色管理",
                "created_time": 1573205350
            },
            {
                "role_id": 14,
                "role_name": "ADMIN_USER_MANAGER",
                "role_label": "系统用户管理",
                "created_time": 1573545074
            }
        ],
        "user_permissions": [
                {
                    "permission_id": 53,
                    "permission_name": "IP_ADVERT_INFO",
                    "permission_label": "获取广告的信息",
                    "created_time": 1575965569
                },
                {
                    "permission_id": 54,
                    "permission_name": "IP_ADVERT_UPDATE",
                    "permission_label": "广告信息的更新",
                    "created_time": 1575965580
                },
                {
                    "permission_id": 55,
                    "permission_name": "IP_ORDER_LIST",
                    "permission_label": "获取订单类表",
                    "created_time": 1575965591
                },
                {
                    "permission_id": 56,
                    "permission_name": "IP_ORDER_INFO",
                    "permission_label": "获取订单的信息",
                    "created_time": 1575965599
                },
                {
                    "permission_id": 57,
                    "permission_name": "IP_ORDER_UPDATE",
                    "permission_label": "更新订单属性",
                    "created_time": 1575965607
                },
                {
                    "permission_id": 58,
                    "permission_name": "IP_ORDER_COMMENT_LIST",
                    "permission_label": "获取订单的评论列表",
                    "created_time": 1575965616
                },
                {
                    "permission_id": 59,
                    "permission_name": "IP_ORDER_COMMENT_UPDATE",
                    "permission_label": "评论属性更改",
                    "created_time": 1575965624
                }
        ],
        "created_time": 1573528721,
        "updated_time": 1573530789
    }
}

Status返回值

状态码 原因
201 传ID格式不正确

获取全部的管理员

可以使用这个接口获取全部管理员用户的信息

接口地址

/admin/manager

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array 管理员(AdminUser:Object)对象

AdminUser:Object 管理员

参数 类型 说明
id int
account string 账号(唯一)
name string 名字
department string 部门
position string 职位
overview string 简介
active_status bool 启用状态
user_role array 角色(Role:Object)列表
updated_time int 更新时间
created_time int 创建时间

Role:Object 权限

参数 类型 说明
role_id int
role_name string 角色明名
role_label string 注释标签
created_time int 创建时间

返回示例

{
    "status":0,
    "list":[
        {
            "id":16,
            "account":"789",
            "name":"张小震",
            "department":"",
            "position":"",
            "overview":"",
            "last_login":1576219604,
            "active_status":false,
            "user_role":[
                {
                    "role_id":15,
                    "role_name":"HUMAN",
                    "role_label":"普通使用者",
                    "created_time":1574847030
                },
                {
                    "role_id":23,
                    "role_name":"SERVICE_CUSTOMER",
                    "role_label":"客服专员",
                    "created_time":1575965974
                }
            ],
            "created_time":1576202977,
            "updated_time":1576203002
        },
        {
            "id":15,
            "account":"456",
            "name":"456",
            "department":"456",
            "position":"456",
            "overview":"456",
            "last_login":1576219603,
            "active_status":false,
            "user_role":[
                {
                    "role_id":10,
                    "role_name":"ADMIN_ROLE_MANAGER",
                    "role_label":"权限角色管理",
                    "created_time":1573205350
                },
                {
                    "role_id":14,
                    "role_name":"ADMIN_USER_MANAGER",
                    "role_label":"系统用户管理",
                    "created_time":1573545074
                },
                {
                    "role_id":15,
                    "role_name":"HUMAN",
                    "role_label":"普通使用者",
                    "created_time":1574847030
                }
            ],
            "created_time":1574942041,
            "updated_time":1576034075
        },
        {
            "id":9,
            "account":"y7ut@163.com",
            "name":"测试账号2",
            "department":"",
            "position":"系统测试",
            "overview":null,
            "active_status":true,
            "user_role":[

            ],
            "created_time":1573528617,
            "updated_time":1573528617
        },
        {
            "id":7,
            "account":"ceshi",
            "name":"测试账号",
            "department":"",
            "position":"管理着",
            "overview":null,
            "active_status":true,
            "user_role":[

            ],
            "created_time":1573528264,
            "updated_time":1573528264
        },
        {
            "id":5,
            "account":"inventore21@163.com",
            "name":"薛梅",
            "department":null,
            "position":null,
            "overview":null,
            "active_status":true,
            "user_role":[

            ],
            "created_time":1572908189,
            "updated_time":1572950173
        },
        {
            "id":4,
            "account":"modi.voluptatem@gmail.com",
            "name":"潘小红",
            "department":null,
            "position":null,
            "overview":null,
            "active_status":true,
            "user_role":[

            ],
            "created_time":1572908103,
            "updated_time":1572950172
        },
        {
            "id":3,
            "account":"jut@yahoo.com",
            "name":"原莹",
            "department":null,
            "position":null,
            "overview":null,
            "active_status":true,
            "user_role":[

            ],
            "created_time":1572908058,
            "updated_time":1572950169
        },
        {
            "id":2,
            "account":"sducimus@163.com",
            "name":"冼勇",
            "department":null,
            "position":null,
            "overview":null,
            "active_status":true,
            "user_role":[

            ],
            "created_time":1572908047,
            "updated_time":1572950170
        },
        {
            "id":1,
            "account":"qenim@163.com",
            "name":"陶洁",
            "department":null,
            "position":null,
            "overview":null,
            "active_status":true,
            "user_role":[

            ],
            "created_time":1572907974,
            "updated_time":1573527577
        }
    ]
}

Status返回值

重置用户密码

可以使用这个接口重置用户密码

接口地址

/admin/manager/{id}/reset_pwd

请求方式

PUT

请求参数

请求示例

curl --location --request GET '/api/admin/manager/213/reset_pwd' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbMV0sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTYzNTgzOTkxNSwiZXhwIjoxNjM2NDQ0NzE1fQ.MHcaByL7YDkSrgL4ZWGlfwCBz_okE_l9fvaWR_OYEUg'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 返回参数

data: object 数据

参数 类型 说明
user_id string 用户id
new_pwd string 重置后的密码

返回示例

{
    "status": 0,
    "error": "",
    "list": {
        "user_id": 213,
        "new_pwd": "123456"
    }
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/27 李世星 新增

角色 role

修改一个角色的属性

更新某一个角色的详情信息。

接口地址

/admin/role/{id}

请求方式

put

请求参数

参数 类型 说明 必填
role_name string 角色名
role_label string 注释标签
permission_list array 权限列表 (里面的元素是权限的ID int)
menu_list array 菜单列表

这部分代表的是,用户拥有这个角色后,所展示的菜单。

如请求示例给服务端传递的话,那么可以代表这个角色需要的菜单为:

-用户权限 (level:1)

|—权限管理 (level:2)

|—角色管理 **(level:2)**

|—用户管理 **(level:2)**

-日志管理(level:1)****

|—日志列表 (level:2)

!!菜单的顺序和menu_list中数组元素的顺序是一样的

而往往每个用户会拥有多个角色,所以这个时候用户实际拥有的菜单就是,每个角色所对应的菜单组合的再次组合,而这顺序是安装 用户的角色先后顺序所控制的,例如这个上面的那个是角色ADMIN (ID为1),当前登录的用户还有一个角色“客户运营”(ID为2)。

这个角色对应的菜单menu_list :

[
        {
            "menu_id": 1, // 客户管理
            "level": 1
        },
        {
            "menu_id": 3, // 客户列表
            "level": 2 
        },
]
则转译成对应的菜单为 

-客户管理(level:1)

|—客户列表 (level:2)

这个时候 如果 在用户的配置中设置角色为 role_list:[ 1,2 ], 那么用户的菜单信息则为

-用户权限 (level:1)

|—权限管理 (level:2)

|—角色管理 **(level:2)**

|—用户管理 **(level:2)**

-日志管理(level:1)****

|—日志列表 (level:2)

-客户管理(level:1)

|—客户列表 (level:2)

反之 [2, 1] 则为

-客户管理(level:1)

|—客户列表 (level:2)

-用户权限 (level:1)

|—权限管理 (level:2)

|—角色管理 **(level:2)**

|—用户管理 **(level:2)**

-日志管理(level:1)****

|—日志列表 (level:2)

所以可以发现 用户最终显示的菜单 会把每个角色对应的菜单按顺序排列,再进行按角色的插入顺序再进行组合 。

用户菜单获取方式参见 -> 获取当前登录的管理员所拥有的配置信息

参数 类型 说明
menu_id int 菜单对应的id
level int 分级 1为 1级标题 2为2级子标题

请求示例

只修改名称

{
    "role_name": "ADMIN_USER",
}

只修改权限

{
      "role_permissions":[1,2],
}

修改菜单排列

{
      "role_permissions":[
        {
            "menu_id": 1, // 客户管理
            "level": 1
        },
        {
            "menu_id": 3, // 客户列表
            "level": 2
        }
    ]
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 角色 (Role:Object)列表

Role:Object 角色

参数 类型 说明
id int
role_name string 角色名
role_label string 注释标签
role_permissions array 权限 (Permission:Object)列表
created_time int 创建时间

Permission:Object 权限

参数 类型 说明
id int
permission_name string 权限名名
permission_label string 注释标签
created_time int 创建时间

Menu:Object 权限

参数 类型 说明
id int
menu_name string 菜单名名
menu_label string 注释标签
icon string 图标
route string 路由
level int 级别

返回示例

{
    "status":0,
    "data":{
        "id":1,
        "role_name":"ADMIN_USER",
        "role_label":"管理员操作者",
        "role_permissions":[
            {
                "id":1,
                "permission_name":"ROLE_TEST_A",
                "permission_label":"A",
                "created_time":1572937826
            },
            {
                "id":2,
                "permission_name":"ROLE_TEST_B",
                "permission_label":"B",
                "created_time":1572937869
            }
        ],
        "menu_list":[
            {
                "id":1,
                "menu_name":"用户权限",
                "menu_label":"用户权限-大标题",
                "icon":"",
                "route":"",
                "level":1
            },
            {
                "id":3,
                "menu_name":"权限管理",
                "menu_label":"用户权限-权限管理",
                "icon":"",
                "route":"",
                "level":2
            },
            {
                "id":5,
                "menu_name":"角色管理",
                "menu_label":"用户权限-角色管理",
                "icon":"",
                "route":"",
                "level":2
            },
            {
                "id":6,
                "menu_name":"用户管理",
                "menu_label":"用户权限-用户管理",
                "icon":"",
                "route":"",
                "level":2
            },
            {
                "id":7,
                "menu_name":"日志管理",
                "menu_label":"日志管理-大标题",
                "icon":"",
                "route":"",
                "level":1
            },
            {
                "id":8,
                "menu_name":"日志列表",
                "menu_label":"日志管理-日志列表",
                "icon":"",
                "route":"",
                "level":2
            }
        ],
        "created_time":1572938186
    }
}

Status返回值

状态码 原因
201 传入ID格式不正确
202 传入的permission有问题
203 角色名被使用了

新增一个操作角色

添加角色的详情信息,包括获取其的权限和菜单排列

接口地址

/admin/role

请求方式

post

请求参数

参数 类型 说明
role_name string 角色名
role_label string 注释标签
permission_list array 权限列表 (里面的元素是权限的ID int)
menu_list array 菜单列表

menu:object

这部分代表的是,用户拥有这个角色后,所展示的菜单。

如请求示例给服务端传递的话,那么可以代表这个角色需要的菜单为:

-用户权限 (level:1)

|—权限管理 (level:2)

|—角色管理 **(level:2)**

|—用户管理 **(level:2)**

-日志管理(level:1)****

***|—日志列表 (level:2)***

!!菜单的顺序和menu_list中数组元素的顺序是一样的

而往往每个用户会拥有多个角色,所以这个时候用户实际拥有的菜单就是,每个角色所对应的菜单组合的再次组合,而这顺序是安装 用户的角色先后顺序所控制的,例如这个上面的那个是角色ADMIN (ID为1),当前登录的用户还有一个角色“客户运营”(ID为2)。

这个角色对应的菜单menu_list :

[
        {
            "menu_id": 1, // 客户管理
            "level": 1
        },
        {
            "menu_id": 3, // 客户列表
            "level": 2 
        },
]
则转译成对应的菜单为 

-客户管理(level:1)

|—客户列表 (level:2)

这个时候 如果 在用户的配置中设置角色为 role_list:[ 1,2 ], 那么用户的菜单信息则为

-用户权限 (level:1)

|—权限管理 (level:2)

|—角色管理 **(level:2)**

|—用户管理 **(level:2)**

-日志管理(level:1)****

|—日志列表 (level:2)

-客户管理(level:1)

|—客户列表 (level:2)

反之 [2, 1] 则为

-客户管理(level:1)

|—客户列表 (level:2)

-用户权限 (level:1)

|—权限管理 (level:2)

|—角色管理 **(level:2)**

|—用户管理 **(level:2)**

-日志管理(level:1)****

|—日志列表 (level:2)

所以可以发现 用户最终显示的菜单 会把每个角色对应的菜单按顺序排列,再进行按角色的插入顺序再进行组合 。

用户菜单获取方式参见 -> 获取当前登录的管理员所拥有的配置信息

参数 类型 说明
menu_id int 菜单对应的id
level int 分级 1为 1级标题 2为2级子标题

请求示例

    {
        "role_name":"ADMIN_USER",
        "role_label":"管理员操作者",
        "permission_list":[1,2],
        "menu_list":[
            {
                "menu_id":1,
                "level":1
            },
            {
                "menu_id":3,
                "level":2
            },
            {
                "menu_id":5,
                "level":2
            },
            {
                "menu_id":6,
                "level":2
            },
            {
                "menu_id":7,
                "level":1
            },
            {
                "menu_id":8,
                "level":2
            }
        ]
    }

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 角色 (Role:Object)列表

Role:Object 角色

参数 类型 说明
id int
role_name string 角色名
role_label string 注释标签
role_permissions array 权限 (Permission:Object)列表
created_time int 创建时间

Permission:Object 权限

参数 类型 说明
id int
permission_name string 权限名名
permission_label string 注释标签
created_time int 创建时间

Menu:Object 菜单

参数 类型 说明
id int
menu_name string 菜单名名
menu_label string 注释标签
icon string 图标
route string 路由
level int 级别

返回示例

{
    "status":0,
    "data":{
        "id":1,
        "role_name":"ADMIN_USER",
        "role_label":"管理员操作者",
        "role_permissions":[
            {
                "id":1,
                "permission_name":"ROLE_TEST_A",
                "permission_label":"A",
                "created_time":1572937826
            },
            {
                "id":2,
                "permission_name":"ROLE_TEST_B",
                "permission_label":"B",
                "created_time":1572937869
            }
        ],
        "menu_list":[
            {
                "id":1,
                "menu_name":"用户权限",
                "menu_label":"用户权限-大标题",
                "icon":"",
                "route":"",
                "level":1
            },
            {
                "id":3,
                "menu_name":"权限管理",
                "menu_label":"用户权限-权限管理",
                "icon":"",
                "route":"",
                "level":2
            },
            {
                "id":5,
                "menu_name":"角色管理",
                "menu_label":"用户权限-角色管理",
                "icon":"",
                "route":"",
                "level":2
            },
            {
                "id":6,
                "menu_name":"用户管理",
                "menu_label":"用户权限-用户管理",
                "icon":"",
                "route":"",
                "level":2
            },
            {
                "id":7,
                "menu_name":"日志管理",
                "menu_label":"日志管理-大标题",
                "icon":"",
                "route":"",
                "level":1
            },
            {
                "id":8,
                "menu_name":"日志列表",
                "menu_label":"日志管理-日志列表",
                "icon":"",
                "route":"",
                "level":2
            }
        ],
        "created_time":1572938186
    }
}

Status返回值

状态码 原因
201 传入ID格式不正确
202 名称被启用

查看系统中全部的角色

每一个用户可以拥有多个角色,每个角色下有多个操作权限,这个接口用来获取系统中全部的角色列表

接口地址

/admin/role

请求方式

get

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array 角色 (Role:Object)列表

Role:Object 角色

参数 类型 说明
id int
role_name string 角色名
role_label string 注释标签
role_permissions array 权限 (Permission:Object)列表
created_time int 创建时间
updated_time int 修改时间

Permission:Object 权限

参数 类型 说明
id int
permission_name string 权限名名
permission_label string 注释标签
created_time int 创建时间

返回示例

{
    "status": 0,
    "list": [
        {
            "id": 2,
            "role_name": "C",
            "role_label": "C的權限",
            "role_permissions": [
                {
                    "id":3,
                    "permission_name": "ROLE_TEST_C",
                    "permission_label": "C",
                    "created_time": 1572937880
                }
            ],
            "created_time": 1572938198
        },
        {
            "id": 1,
            "role_name": "AB",
            "role_label": "A的權限+B的權限",
            "role_permissions": [
                {
                    "id":1,
                    "permission_name": "ROLE_TEST_A",
                    "permission_label": "A",
                    "created_time": 1572937826
                },
                {
                    "id":2,
                    "permission_name": "ROLE_TEST_B",
                    "permission_label": "B",
                    "created_time": 1572937869
                }
            ],
            "created_time": 1572938186
        }
    ]
}

Status返回值

查看角色的属性

更新某一个角色的详情信息。

接口地址

/admin/role/{id}

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 角色 (Role:Object)列表

Role:Object 角色

参数 类型 说明
id int
role_name string 角色名
role_label string 注释标签
role_permissions array 权限 (Permission:Object)列表
created_time int 创建时间

Permission:Object 权限

参数 类型 说明
id int
permission_name string 权限名名
permission_label string 注释标签
created_time int 创建时间

Menu:Object 权限

参数 类型 说明
id int
menu_name string 菜单名名
menu_label string 注释标签
icon string 图标
route string 路由
level int 级别

返回示例

{
    "status":0,
    "data":{
        "id":1,
        "role_name":"ADMIN_USER",
        "role_label":"管理员操作者",
        "role_permissions":[
            {
                "id":1,
                "permission_name":"ROLE_TEST_A",
                "permission_label":"A",
                "created_time":1572937826
            },
            {
                "id":2,
                "permission_name":"ROLE_TEST_B",
                "permission_label":"B",
                "created_time":1572937869
            }
        ],
        "menu_list":[
            {
                "id":1,
                "menu_name":"用户权限",
                "menu_label":"用户权限-大标题",
                "icon":"",
                "route":"",
                "level":1
            },
            {
                "id":3,
                "menu_name":"权限管理",
                "menu_label":"用户权限-权限管理",
                "icon":"",
                "route":"",
                "level":2
            },
            {
                "id":5,
                "menu_name":"角色管理",
                "menu_label":"用户权限-角色管理",
                "icon":"",
                "route":"",
                "level":2
            },
            {
                "id":6,
                "menu_name":"用户管理",
                "menu_label":"用户权限-用户管理",
                "icon":"",
                "route":"",
                "level":2
            },
            {
                "id":7,
                "menu_name":"日志管理",
                "menu_label":"日志管理-大标题",
                "icon":"",
                "route":"",
                "level":1
            },
            {
                "id":8,
                "menu_name":"日志列表",
                "menu_label":"日志管理-日志列表",
                "icon":"",
                "route":"",
                "level":2
            }
        ],
        "created_time":1572938186
    }
}

Status返回值

状态码 原因
201 传入ID格式不正确

权限管理 permission

获取权限详细信息

更新某一个权限的详情信息,操作权限对应每一个api接口的行为,即每一个权限都是一个路由的名称。

接口地址

/admin/permission/{id}

请求方式

put

请求参数

参数 类型 说明 必填
permission_name string 权限
permission_label string 注释标签

请求示例

{
    "permission_name": "ADMIN_USER_INFO",
    "permission_label": "新增管理员用户"
     "is_log": false,
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 权限 (Permission:Object)

Permission:Object 权限

参数 类型 说明
id int
permission_name string 权限名名
permission_label string 注释标签
permission_role Array 所属角色的列表
handle_log bool 是否敏感操作
created_time int 创建时间

返回示例

{
    "status": 0,
    "data":{
            "id": 3,
            "permission_name": "ADMIN_USER_INFO",
            "permission_label": "新增管理员用户",
            "handle_log": false,
            "created_time": 1572937880
    }
}

Status返回值

状态码 原因
201 传入ID格式不正确
202 名字重复
203 数据库错误

添加新的权限信息

添加新的权限信息,操作权限对应每一个api接口的行为,即每一个权限都是一个路由的名称。

接口地址

/admin/permission

请求方式

POST

请求参数

参数 类型 说明
permission_name string 权限名
permission_label string 注释标签

请求示例

{
    "permission_name": "ADMIN_USER_INFO",
    "permission_label": "新增管理员用户",
"is_log":true
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data string 权限 (Permission:Object)

Permission:Object 权限

参数 类型 说明
id int
permission_name string 权限名名
permission_label string 注释标签
created_time int 创建时间

返回示例

{
    "status": 0,
    "data":{
            "id": 3,
            "permission_name": "ADMIN_USER_INFO",
            "permission_label": "新增管理员用户",
            "created_time": 1572937880
    }
}

Status返回值

状态码 原因
201 权限名已经被使用
202 数据库错误

获取权限详细信息

查看某一个权限的详情信息,操作权限对应每一个api接口的行为,即每一个权限都是一个路由的名称。

接口地址

/admin/permission/{id}

请求方式

put

请求参数

参数 类型 说明 必填
permission_name string 权限
permission_label string 注释标签

请求示例

{
    "permission_name": "ADMIN_USER_INFO",
    "permission_label": "新增管理员用户"
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 权限 (Permission:Object)

Permission:Object 权限

参数 类型 说明
id int
permission_name string 权限名名
permission_label string 注释标签
permission_role Array 所属角色的列表
handle_log bool 是否敏感操作
created_time int 创建时间

返回示例

{
    "status": 0,
    "data":{
            "id": 3,
            "permission_name": "ADMIN_USER_INFO",
            "permission_label": "新增管理员用户",
            "handle_log": false,
            "created_time": 1572937880
    }
}

Status返回值

状态码 原因
201 传入ID格式不正确
202 名字重复
203 数据库错误

获取权限列表

获取全部的操作权限,操作权限对应每一个api接口的行为,即每一个权限都是一个路由的名称。

接口地址

/admin/permission

请求方式

get

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array 权限 (Permission:Object)列表

Permission:Object 权限

参数 类型 说明
id int
permission_name string 权限名名
permission_label string 注释标签
created_time int 创建时间
updated_time int 修改时间

返回示例

{
    "status": 0,
    "list": [
        {
            "id": 7,
            "permission_name": "ADMIN_ROLE_STORE",
            "permission_label": "新增一个角色的信息",
            "handle_log": false,
            "created_time": 1573545197
        },
        {
            "id": 6,
            "permission_name": "ADMIN_ROLE_UPDATE",
            "permission_label": "修改某一个角色的信息",
            "handle_log": false,
            "created_time": 1573545170
        },
        {
            "id": 17,
            "permission_name": "ADMIN_USER_UPDATE",
            "permission_label": "更新某一个用户的信息",
            "handle_log": false,
            "created_time": 1573544897
        },
        {
            "id": 16,
            "permission_name": "ADMIN_USER_INFO",
            "permission_label": "获取某一个用户信息",
            "handle_log": false,
            "created_time": 1573544881
        }
    ]
}

Status返回值

oms导航菜单 admin:menu

修改导航菜单的属性信息

修改导航菜单

接口地址

/admin/menu/{id}

请求方式

PUT

请求参数

参数 类型 说明 必填
menu_name string 菜单名名
menu_label string 注释标签
icon string 图标
route string 路由

请求示例

{
        "icon":"fa_fa",
        "route":"#",
        "show":true
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 菜单(menu:Object)列表

menu:Object 菜单

参数 类型 说明
id int
menu_name string 菜单名名
menu_label string 注释标签
icon string 图标
route string 路由
show bool 是否显示
created_time int 创建时间

返回示例

{
    "status":0,
    "data":{
        "id":1,
        "menu_name":"用户权限",
        "menu_label":"用户权限-大标题",
        "icon":"fa_fa",
        "route":"#",
        "show":true,
        "created_time":1573544881
    }
}

Status返回值

状态码 原因
201 传入ID格式不正确

新增一个导航菜单

新增导航菜单

接口地址

/admin/menu

请求方式

POST

请求参数

参数 类型 说明
menu_name string 菜单名名
menu_label string 注释标签
icon string 图标
route string 路由

请求示例

{
        "menu_name":"用户权限",
        "menu_label":"用户权限-大标题",
        "icon":"",
        "route":"",
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 菜单(menu:Object)列表

menu:Object 菜单

参数 类型 说明
id int
menu_name string 菜单名名
menu_label string 注释标签
icon string 图标
route string 路由
show bool 是否显示
created_time int 创建时间

返回示例

{
    "status":0,
    "data":{
        "id":1,
        "menu_name":"用户权限",
        "menu_label":"用户权限-大标题",
        "icon":"",
        "route":"",
        "show": false,
        "created_time":1573544881
    }
}

Status返回值

状态码 原因
201 传入ID格式不正确

查看全部的导航菜单

获取全部的导航菜单的数据信息

接口地址

/admin/menu

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array 菜单(menu:Object)列表

menu:Object 菜单

参数 类型 说明
id int
menu_name string 菜单名名
menu_label string 注释标签
icon string 图标
route string 路由
show bool 是都显示
created_time int 创建时间
updated_time int 修改时间

返回示例

{
    "status":0,
    "data":[
        {
            "id":1,
            "menu_name":"用户权限",
            "menu_label":"用户权限-大标题",
            "icon":"",
            "route":"",
            "show": true,
            "created_time":1573544881
        },
        {
            "id":3,
            "menu_name":"权限管理",
            "menu_label":"用户权限-权限管理",
            "icon":"",
            "route":"",
            "show": true,
            "created_time":1573544881
        },
        {
            "id":5,
            "menu_name":"角色管理",
            "menu_label":"用户权限-角色管理",
            "icon":"",
            "route":"",
            "show": true,
            "created_time":1573544881
        },
        {
            "id":6,
            "menu_name":"用户管理",
            "menu_label":"用户权限-用户管理",
            "icon":"",
            "route":"",
            "show": true,
            "created_time":1573544881
        },
        {
            "id":7,
            "menu_name":"日志管理",
            "menu_label":"日志管理-大标题",
            "icon":"",
            "route":"",
            "show": true,
            "created_time":1573544881
        },
        {
            "id":8,
            "menu_name":"日志列表",
            "menu_label":"日志管理-日志列表",
            "icon":"",
            "route":"",
            "show": true,
            "created_time":1573544881
        }
    ]
}

Status返回值

查看全部的操作日志

查看全部的操作日志

接口地址

/log/handle

请求方式

GET

请求参数

Query

参数 类型 说明
manager int 管理员ID
date int 20190413 日期
handle string permission的name

请求示例

/log/handle?date=20200408

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array log:Object日志 列表

log:Object日志

参数 类型 说明
id int
handle string 操作简介handle_label
request_id string 请求UID
manager_id string 操作人ID
manager_name string 操作人姓名
handle_name string 操作名称
request_path string 请求地址
header string 头部信息
created_time int 操作时间

返回示例

{
    "status": 0,
    "data": [
        {
            "handle": "ADMIN_MANAGER_INFO",
            "request_id": "4623211",
            "manager_id": "2",
            "manager_name": "测试账号",
            "handle_name": "获取管理员信息",
            "request_path": "/api/admin/manager/7",
            "header": {
                "HTTP_AUTHORIZATION": [
                    "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbMSwyLDMsNCw1LDgsOV0sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTU4NjMxNTE3MiwiZXhwIjoxNTg2MzE4NzcyfQ.7T0SbB4245c6njZImJMinpUHZ-GNIf7RBKesKpvtLCE"
                ],
                "HTTP_CONTENT_TYPE": [
                    "application/json"
                ],
                "HTTP_CACHE_CONTROL": [
                    "no-cache"
                ],
                "HTTP_POSTMAN_TOKEN": [
                    "6a9fe78c-55b9-400b-bbe9-ab71deb95371"
                ],
                "HTTP_USER_AGENT": [
                    "PostmanRuntime/7.6.0"
                ],
                "HTTP_ACCEPT": [
                    "*/*"
                ],
                "HTTP_HOST": [
                    "localhost:8080"
                ],
                "HTTP_ACCEPT_ENCODING": [
                    "gzip, deflate"
                ],
                "HTTP_CONNECTION": [
                    "keep-alive"
                ]
            },
            "created_time": "Wed, 08 Apr 2020 03:53:59 +0000"
        },
        {
            "handle": "ADMIN_MANAGER_INFO",
            "request_id": "1ec7c76",
            "manager_id": "1",
            "manager_name": "测试账号",
            "handle_name": "获取管理员信息",
            "request_path": "/api/admin/manager/7",
            "header": {
                "HTTP_AUTHORIZATION": [
                    "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbMSwyLDMsNCw1LDgsOV0sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTU4NjMyNTc2MiwiZXhwIjoxNTg2MzI5MzYyfQ.EsI6Ko_vOWrQxGE0eVg1qFptW3VDgvR5R-b3xP7TJ3s"
                ],
                "HTTP_CONTENT_TYPE": [
                    "application/json"
                ],
                "HTTP_CACHE_CONTROL": [
                    "no-cache"
                ],
                "HTTP_POSTMAN_TOKEN": [
                    "b01908b4-0330-4c51-bc77-268eeb2f763a"
                ],
                "HTTP_USER_AGENT": [
                    "PostmanRuntime/7.6.0"
                ],
                "HTTP_ACCEPT": [
                    "*/*"
                ],
                "HTTP_HOST": [
                    "localhost:8080"
                ],
                "HTTP_ACCEPT_ENCODING": [
                    "gzip, deflate"
                ],
                "HTTP_CONNECTION": [
                    "keep-alive"
                ]
            },
            "created_time": "Wed, 08 Apr 2020 06:03:20 +0000"
        },
        {
            "handle": "ADMIN_MANAGER_LIST",
            "request_id": "200898a",
            "manager_id": "1",
            "manager_name": "测试账号",
            "handle_name": "获取全部的管理员列表",
            "request_path": "/api/admin/manager",
            "header": {
                "HTTP_AUTHORIZATION": [
                    "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbMSwyLDMsNCw1LDgsOV0sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTU4NjMyNTc2MiwiZXhwIjoxNTg2MzI5MzYyfQ.EsI6Ko_vOWrQxGE0eVg1qFptW3VDgvR5R-b3xP7TJ3s"
                ],
                "HTTP_CONTENT_TYPE": [
                    "application/json"
                ],
                "HTTP_CACHE_CONTROL": [
                    "no-cache"
                ],
                "HTTP_POSTMAN_TOKEN": [
                    "844160bc-0824-4f37-b808-c462b81335b2"
                ],
                "HTTP_USER_AGENT": [
                    "PostmanRuntime/7.6.0"
                ],
                "HTTP_ACCEPT": [
                    "*/*"
                ],
                "HTTP_HOST": [
                    "localhost:8080"
                ],
                "HTTP_ACCEPT_ENCODING": [
                    "gzip, deflate"
                ],
                "HTTP_CONNECTION": [
                    "keep-alive"
                ]
            },
            "created_time": "Wed, 08 Apr 2020 06:03:26 +0000"
        }
    ]
}

Status返回值

查看导航菜单的属性信息

获取导航菜单的数据信息

接口地址

/admin/menus/{id}

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 菜单(menu:Object)列表

menu:Object 菜单

参数 类型 说明
id int
menu_name string 菜单名名
menu_label string 注释标签
icon string 图标
route string 路由
show bool 是否显示
created_time int 创建时间

返回示例

{
    "status":0,
    "data":{
        "id":1,
        "menu_name":"用户权限",
        "menu_label":"用户权限-大标题",
        "icon":"",
        "route":"",
        "show": true,
        "created_time":1573544881
    }
}

Status返回值

状态码 原因
201 传入ID格式不正确

用户配置 auth:detail

修改登录用户的配置信息

使用这个接口 修改当前登录用户的配置信息

接口地址

/auth/detail

请求方式

PUT

请求参数

参数 类型 说明 必填
name string 名字
department string 部门
position string 职位
overview string 简介
password string 密码

请求示例

//单独修改密码
{
    "password":"112312132"
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 管理员(Manager:Object)对象

Manager:Object管理员

参数 类型 说明
id int
account string 账号(唯一)
name string 名字
department string 部门
position string 职位
overview string 简介
updated_time int 更新时间
created_time int 创建时间

返回示例

{
    "status": 0,
    "data": {
        "id": 10,
        "account": "y8ut@163.com",
        "name": "测试账号1",
        "department": "",
        "position": "系统测试",
        "overview": "",
        "created_time": 1573528721,
        "updated_time": 1573530789
    }
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

修改登录用户的配置信息

使用这个接口 获取当前登录的用户所拥有的配置信息

接口地址

/auth/detail

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 管理员(Manager:Object)对象

Manager:Object管理员

参数 类型 说明
id int
account string 账号(唯一)
name string 名字
department string 部门
position string 职位
overview string 简介
active_status bool 启用状态
user_role array 角色(Role:Object)列表
menu_list array 菜单(Menu:Object)列表
updated_time int 更新时间
created_time int 创建时间

Role:Object 权限

参数 类型 说明
role_id int
role_name string 角色明名
role_label string 注释标签
created_time int 创建时间

Menu:Object权限

用户的菜单设置方式见角色相关接口 新增一个操作角色

参数 类型 说明
menu_id int
menu_name string 标题名称
menu_label string 备注
icon string 图标
route string 路由
from_role string 源自于角色
children array 菜单(Menu:Object)列表

返回示例

 {
    "status": 0,
    "data": {
        "id": 1,
        "account": "ceshi",
        "name": "测试用户",
        "department": "集微网",
        "position": "前端",
        "overview": "测试用户简介",
        "last_login": 1583498649,
        "active_status": true,
        "user_role": [
            {
                "role_id": 2,
                "role_name": "招聘频道运营",
                "role_label": "拥有招聘频道部分权限",
                "created_time": 1582858227
            },
            {
                "role_id": 3,
                "role_name": "普通用户",
                "role_label": "普通用户",
                "created_time": 1583470419
            },
            {
                "role_id": 4,
                "role_name": "系统运维",
                "role_label": "系统管理员",
                "created_time": 1583471336
            }
        ],
        "created_time": 1583215282,
        "updated_time": 1583498649,
        "menuList": [
            {
                "menu_id": 5,
                "menu_name": "配置管理",                    // 对应level=1
                "menu_label": "招聘频道-配置管理",
                "icon": "",
                "route": "",
                "from_role": "招聘频道运营",    
                "children": []
            },
            {
                "menu_id": 3,
                "menu_name": "简历管理",                 // 对应level=1
                "menu_label": "招聘频道-简历管理",
                "icon": "",
                "route": "",
                "from_role": "普通用户",
                "children": [
                    {
                        "menu_id": 4,
                        "menu_name": "简历列表",         // 对应level=2
                        "menu_label": "招聘频道-简历列表",
                        "icon": "",
                        "route": "",
                        "from_role": "普通用户"
                    }
                ]
            },
            {
                "menu_id": 1,
                "menu_name": "客户管理",                 // 对应level=1                         
                "menu_label": "招聘频道-客户管理",
                "icon": "",
                "route": "",
                "from_role": "系统运维",
                "children": [
                    {
                        "menu_id": 2,
                        "menu_name": "客户列表",           // 对应level=2
                        "menu_label": "招聘频道-客户列表",
                        "icon": "",
                        "route": "",
                        "from_role": "系统运维"
                    },
                    {
                        "menu_id": 7,
                        "menu_name": "福利标签",           // 对应level=2
                        "menu_label": "招聘频道-福利标签",
                        "icon": "",
                        "route": "",
                        "from_role": "系统运维"
                    },
                    {
                        "menu_id": 6,
                        "menu_name": "职能分类",           // 对应level=2
                        "menu_label": "招聘频道-职能分类",
                        "icon": "",
                        "route": "",
                        "from_role": "系统运维"
                    }
                ]
            }
        ]
    }
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

服务类型信息 project:case

获取全部的可使用客户服务分类类型

接口地址

/saas/job/config/project/case

请求方式

GET

请求参数

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array 类型(Case)列表

Case:Object类别

参数 类型 说明
id int
name string 名名
label string 注释
code string 识别码

返回示例

{
    "status": 0,
    "data": [
        {
            "id": 1,
            "name": "HR",
            "label": "HR",
            "code": "hr"
        },
        {
            "id": 2,
            "name": "猎头",
            "label": "猎头",
            "code": "hunter"
        }
    ]
}

Status返回值

oms客户管理 job:customer

修改招聘服务的客户的信息

修改招聘服务的客户

接口地址

/saas/job/customer/{id}

请求方式

PUT

请求参数

参数 类型 说明
name string 客户名字
company_name string 公司名字
company_short string 公司简称
logo string LOGO
overview string 简介
scale int 传1,2,3,4,5 规模 对应1-49,50-100,等
capitalization string 融资情况
address string 地址
contact_name string 联系人名称
contact_tele string 电话
contact_email string 邮箱
customer_service_name string 客服名称
customer_service_tele string 客服电话
customer_service_email string 客服邮箱
sign_date int 激活日期
member_name string 账户联系人
member_tele string 账户联系电话
customer_labels string 公司标签
account string 登录账号
additional_info jsonString 额外信息

additional_info

参数 类型 说明
live_url string 直播地址
live_starttime timestamp 开播时间
live_duration int 直播时长

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array 客户(Customer:Object)对象

Customer:Object管理员

参数 类型 说明
id int
name string 客户名字
company_name string 公司名字
logo string LOGO
overview string 简介
scale string 公司规模
capitalization bool 融资情况
address array 地址
contact_name string 联系人名称
contact_tele string 电话
contact_email string 邮箱
customer_service_name string 客服名称
customer_service_tele int 客服电话
customer_service_email string 客服邮箱
active_status 状态
sign_date 激活注册日期
owner 创建者
member_count 成员数量
service 服务object
updated_time int 更新时间
created_time int 创建时间

service:Object 权限

参数 类型 说明
project object 服务类型Project:object
case object 服务案例case:object
level object 服务级别level:object

服务类型Project:object

参数 类型 说明
name string 名称
label string 简介

服务案例case:object

参数 类型 说明
name string 名称 (HR 或 猎头 等)
label string 简介

服务级别level:object

参数 类型 说明
name string 名称
label string 简介

返回示例

 {
    "status": 0,
    "data": {
        "id": 16,
        "customer_name": "客户名称99",
        "company_name": "客户名称99",
        "address": "参和平区",
        "logo": "http://s.laoyaoba.com/http://s.laoyaoba.com/2.jpg",
        "capitalization": "融资阶段!",
        "scale": "不限",
        "overview": "简介",
        "contact_name": "张撒旦",
        "contact_email": "yyy@a.com",
        "contact_tele": "123123123",
        "customer_service_name": "都阿松",
        "customer_service_email": "asdas@a.com",
        "customer_service_tele": "98876453",
        "sign_date": 2020,
        "created_time": 1585898726,
        "updated_time": 1585898726
    }
}

Status返回值

**Log

日期 作者 内容
2021/09/13 李世星 修改新增参数 company_labels(公司标签),additional_info(公司附加直播信息)
2022/01/28 张宏伟 修改编辑参数 新增账号字段修改

招聘服务的所有子服务项目类型

获取HR和猎头等信息

接口地址

/saas/job/customer/project/case

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array 客户(caser:Object)对象

服务案例case:object

参数 类型 说明
id int
name string 名称 (HR 或 猎头 等)
label string 简介

返回示例

 

Status返回值

新增招聘服务的客户

新增招聘服务的客户

接口地址

/saas/job/customer

请求方式

POST

请求参数

参数 类型 说明
name string 客户名字
company_name string 公司名字
company_short string 公司简称
logo string LOGO
overview string 简介
scale int 传1,2,3,4,5 规模 对应1-49,50-100,等
capitalization string 融资情况
address string 地址
contact_name string 联系人名称
contact_tele string 电话
contact_email string 邮箱
customer_service_name string 客服名称
customer_service_tele string 客服电话
customer_service_email string 客服邮箱
case_type string 账号类型 case code HR或 hunter
account string 登录账号
member_name string 账户联系人
member_tele string 账户联系电话
customer_labels string 公司标签    "本科","光电显示"
additional_info AdditionalInfo:Object 额外信息
password string 登录密码
sign_date int 激活日期

additional_info

参数 类型 说明
live_url string 直播地址
live_starttime timestamp 开播时间
live_duration int 直播时长

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array 客户(Customer:Object)对象

Customer:Object管理员

参数 类型 说明
id int
name string 客户名字
company_name string 公司名字
logo string LOGO
overview string 简介
scale string 公司规模
capitalization bool 融资情况
address array 地址
contact_name 联系人名称
contact_tele 电话
contact_email 邮箱
customer_service_name 客服名称
customer_service_tele 客服电话
customer_service_email 客服邮箱
active_status 状态
sign_date 激活注册日期
owner 创建者
member_count 成员数量
service 服务object
updated_time int 更新时间
created_time int 创建时间

service:Object 权限

参数 类型 说明
project object 服务类型Project:object
case object 服务案例case:object
level object 服务级别level:object

服务类型Project:object

参数 类型 说明
name string 名称
label string 简介

服务案例case:object

参数 类型 说明
name string 名称 (HR 或 猎头 等)
label string 简介

服务级别level:object

参数 类型 说明
name string 名称
label string 简介

返回示例

 {
  "status": 0,
  "data": {
    "id": 16,
    "customer_name": "客户名称99",
    "company_name": "客户名称99",
    "address": "参和平区",
    "logo": "http://s.laoyaoba.com/2.jpg",
    "capitalization": "融资阶段!",
    "scale": "50~99",
    "overview": "简介",
    "contact_name": "张撒旦",
    "contact_email": "yyy@a.com",
    "contact_tele": "123123123",
    "customer_service_name": "都阿松",
    "customer_service_email": "asdas@a.com",
    "customer_service_tele": "98876453",
    "sign_date": 2020,
    "member_list": [
      {
        "member_id": 18,
        "member_name": "客户名称99",
        "contact_phone": null,
        "contact_email": null,
        "member_role": {
          "member_role_id": 11,
          "member_role_name": "ROOT",
          "member_role_label": "管理员"
        }
      }
    ],
    "service": {
      "project": {
        "project_id": 1,
        "project_name": "招聘",
        "project_label": "招聘服务"
      },
      "case": {
        "case_id": 1,
        "case_name": "HR",
        "case_label": "HR"
      },
      "level": {
        "level_id": 1,
        "level_name": "普通",
        "level_label": "普通HR服务"
      }
    },
    "created_time": 1585898726,
    "updated_time": 1585898726
  }
}

Status返回值

Log

日期 作者 内容
2021/09/13 李世星 修改新增参数 company_labels(公司标签),additional_info(公司附加直播信息)

查看招聘服务的某一个客户的信息

可以使用这个接口获取客户的信息

接口地址

/saas/job/customer/{id}

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 客户(Customer:Object)对象

Customer:Object管理员

参数 类型 说明
id int
name string 客户名字
company_name string 公司名字
company_short string 公司简称
logo string LOGO
overview string 简介
scale string 公司规模
capitalization bool 融资情况
address array 地址
contact_name 联系人名称
contact_tele 电话
contact_email 邮箱
customer_service_name 客服名称
customer_service_tele 客服电话
customer_service_email 客服邮箱
active_status 状态
sign_date 激活注册日期
owner 创建者
member_count 成员数量
service object 服务object
numbers array 成员object
updated_time int 更新时间
created_time int 创建时间

service:Object 权限

参数 类型 说明
project object 服务类型Project:object
case object 服务案例case:object
level object 服务级别level:object

服务类型Project:object

参数 类型 说明
name string 名称
label string 简介

服务案例case:object

参数 类型 说明
name string 名称 (HR 或 猎头 等)
label string 简介

服务级别level:object

参数 类型 说明
name string 名称
label string 简介

成员object

参数 类型 说明
number_id
account string 名称
nickname string 简介
email string
tele string
active_status
role object 客户成员角色object

客户成员角色role:object

参数 类型 说明
number_role_id
name string 名称
label string 简介

返回示例

 

Status返回值

获取OMS全部的企业客户

可以使用这个接口获取全部企业客户的信息

接口地址

/saas/job/customer

请求方式

GET

请求参数

参数 类型 说明
case string case code (hr 或 hunter)
search string 搜索
top Number 是否置顶(1-置顶 0-取消置顶)

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array 客户(Customer:Object)对象

Customer:Object管理员

参数 类型 说明
id int
company_name string 公司名字
customer_name string 客户名称
address string 地址
contact_email string 邮箱
contact_tele string 电话
is_hot enum 是否推荐 0-否 1-是
resume_num int 投递简历数
top_time bool 是否置顶:true-是 false-否

返回示例

{
  "status": 0,
  "current_page": 1,
  "last_page": 10,
  "total": 99,
  "data": [
    {
      "id": 155,
      "customer_name": "测试猎头账户",
      "company_name": "测试猎头账户",
      "address": "",
      "contact_email": "905503981@qq.com",
      "contact_tele": "15510109417",
      "is_hot": false,
      "resume_num": 0,
      "top_time": false
    },
    {
      "id": 154,
      "customer_name": "于斌有限公司",
      "company_name": "于斌有限公司",
      "address": "北京呀",
      "contact_email": "905503981@qq.com",
      "contact_tele": "15846200417",
      "is_hot": true,
      "resume_num": 18,
      "top_time": true
    }
  ]
}

Status返回值

Log

日期 作者 内容
2022/07/13 李晓东 修改列表返回信息

重置客户的管理员账户密码

接口地址

/saas/job/customer/{id}/password/reset

请求方式

PUT

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message

返回示例

{
  "status": 0
}

Status返回值

修改招聘服务的客户权限

接口地址

/saas/job/customer/{id}/role

请求方式

PUT

请求参数

参数 类型 说明
id int 客户id
role_detail josn 权限数组

返回示例

{
    "status": 0,
    "data": {
        "id": 133,
        "customer_name": "emp调试"
    }
}

Error

Code Message Description
201 Role role_detail is empty 字段传值为空或者客户id无效

Status返回值

修改招聘服务的客户热门状态

接口地址

/saas/job/customer/{id}/hot

请求方式

get

请求参数

参数 类型 说明
id int 客户id

返回示例

 {
  "status": 0,
  "data": []
}

Error

Code Message Description
201 Role role_detail is empty 字段传值为空或者客户id无效

Status返回值

查看某一个客户权限的信息

接口地址

/saas/job/customer/{id}/role

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明
id int 客户id
参数 类型 说明
customer_id int 客户id
role_detail json 客户权限信息

role_detail详细参数

参数 类型 说明
id int 当前权限菜单id
title string 权限菜单名称
parent_id int 权限菜单父级id 0为定级
view_code int 当前菜单查看权限 0无权限 1所有人 2本人
handle_code int 当前菜单操作权限 0无权限 1所有人 2本人
view_power array 当前菜单查看权限选项
code int 权限代号
power string 代号名
isActive bool 选中状态
handle_power array 当前菜单操作权限选项 (组内字段含义同查看权限)
menu array 当前菜单所包含的子菜单
isActive bool 选中状态

返回示例

{
    "status": 0,
    "data": {
        "customer_id": "133",
        "role_detail": [
            {
                "id": 1,
                "title": "我的资料",
                "parent_id": 0,
                "view_code": 1,
                "handle_code": 0,
                "rel_id": 1,
                "view_power": [
                    {
                        "code": 1,
                        "power": "所有人",
                        "isActive": true
                    },
                    {
                        "code": 2,
                        "power": "本人",
                        "isActive": false
                    }
                ],
                "handle_power": [
                    {
                        "code": 1,
                        "power": "所有人",
                        "isActive": false
                    },
                    {
                        "code": 2,
                        "power": "本人",
                        "isActive": false
                    }
                ],
                "menu": [
                    {
                        "id": 2,
                        "title": "个人中心",
                        "parent_id": 1,
                        "view_code": 1,
                        "handle_code": 0,
                        "rel_id": 2,
                        "isActive": true
                    }
                ]
            },
            {
                "id": 3,
                "title": "数据中心",
                "parent_id": 0,
                "view_code": 1,
                "handle_code": 1,
                "rel_id": 3,
                "view_power": [
                    {
                        "code": 1,
                        "power": "所有人",
                        "isActive": true
                    },
                    {
                        "code": 2,
                        "power": "本人",
                        "isActive": false
                    }
                ],
                "handle_power": [
                    {
                        "code": 1,
                        "power": "所有人",
                        "isActive": true
                    },
                    {
                        "code": 2,
                        "power": "本人",
                        "isActive": false
                    }
                ],
                "menu": [
                    {
                        "id": 4,
                        "title": "基础服务",
                        "parent_id": 3,
                        "view_code": 1,
                        "handle_code": 1,
                        "rel_id": 4,
                        "isActive": true
                    }
                ]
            },
            {
                "id": 5,
                "title": "职位管理",
                "parent_id": 0,
                "view_code": 1,
                "handle_code": 1,
                "rel_id": 5,
                "view_power": [
                    {
                        "code": 1,
                        "power": "所有人",
                        "isActive": true
                    },
                    {
                        "code": 2,
                        "power": "本人",
                        "isActive": false
                    }
                ],
                "handle_power": [
                    {
                        "code": 1,
                        "power": "所有人",
                        "isActive": true
                    },
                    {
                        "code": 2,
                        "power": "本人",
                        "isActive": false
                    }
                ],
                "menu": [
                    {
                        "id": 6,
                        "title": "职位列表",
                        "parent_id": 5,
                        "view_code": 1,
                        "handle_code": 1,
                        "rel_id": 6,
                        "isActive": true
                    }
                ]
            },
            {
                "id": 7,
                "title": "简历管理",
                "parent_id": 0,
                "view_code": 1,
                "handle_code": 1,
                "rel_id": 7,
                "view_power": [
                    {
                        "code": 1,
                        "power": "所有人",
                        "isActive": true
                    },
                    {
                        "code": 2,
                        "power": "本人",
                        "isActive": false
                    }
                ],
                "handle_power": [
                    {
                        "code": 1,
                        "power": "所有人",
                        "isActive": true
                    },
                    {
                        "code": 2,
                        "power": "本人",
                        "isActive": false
                    }
                ],
                "menu": [
                    {
                        "id": 8,
                        "title": "简历列表",
                        "parent_id": 7,
                        "view_code": 1,
                        "handle_code": 1,
                        "rel_id": 8,
                        "isActive": true
                    }
                ]
            },
            {
                "id": 9,
                "title": "权限与账号",
                "parent_id": 0,
                "view_code": 1,
                "handle_code": 1,
                "rel_id": 9,
                "view_power": [
                    {
                        "code": 1,
                        "power": "所有人",
                        "isActive": true
                    },
                    {
                        "code": 2,
                        "power": "本人",
                        "isActive": false
                    }
                ],
                "handle_power": [
                    {
                        "code": 1,
                        "power": "所有人",
                        "isActive": true
                    },
                    {
                        "code": 2,
                        "power": "本人",
                        "isActive": false
                    }
                ],
                "menu": [
                    {
                        "id": 10,
                        "title": "角色权限",
                        "parent_id": 9,
                        "view_code": 1,
                        "handle_code": 1,
                        "rel_id": 10,
                        "isActive": true
                    },
                    {
                        "id": 11,
                        "title": "账号管理",
                        "parent_id": 9,
                        "view_code": 1,
                        "handle_code": 1,
                        "rel_id": 11,
                        "isActive": true
                    }
                ]
            }
        ]
    }
}

Status返回值

Error

Code Message Description
201 Role role_detail is empty 字段传值为空或者客户id无效

**Log

日期 作者 内容
2022/01/28 张宏伟 修改权限逻辑

删除服务客户公司及账号(软删除)

接口地址

/saas/job/customer/{id}

请求方式

DELETE

请求参数

id

请求示例

/api/saas/job/customer/13

返回参数

参数 类型 说明
id int 客户id

返回示例

 {
    "status": 0,
    "data": ""
}

Status返回值

Error

Code Message Description
201 Role role_detail is empty 字段传值为空或者客户id无效

**Log

日期 作者 内容
2022/01/28 张宏伟 新增接口

设置某个客户企业置顶

接口地址

/saas/job/customer/{id}/top

请求方式

PUT

请求参数

参数 类型 说明
is_top enum 1-置顶 0-取消置顶

请求示例

/api/saas/job/customer/13/top

返回参数

参数 类型 说明
id int 客户id
top_time bool 当前置顶状态:true-已置顶 false-取消置顶

返回示例

{
  "status": 0,
  "data": {
    "id": 13,
    "top_time": true
  }
}

Status返回值

Error

Code Message Description
201 Role role_detail is empty 字段传值为空或者客户id无效

**Log

日期 作者 内容
2022/07/14 李晓东 新增接口

福利 config:welfare

删除多个福利

接口地址

saas/job/config/welfare

请求方式

DELETE

请求参数

参数 类型 说明
treatment_list array 里面是福利的id

请求示例

{
    "treatment_list" : [9,8]
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
affect int 受影响的数量

返回示例

{
    "status":0,
   "affect": 2
}

Status返回值

status 说明
201 id错误

查看某一个福利待遇的属性

查看福利待遇属性

接口地址

saas/job/config/welfare/{id}

请求方式

DELETE

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message

返回示例

{
    "status": 0
}

Status返回值

新增一个福利待遇

新增一个福利待遇属性

接口地址

saas/job/config/welfare

请求方式

POST

请求参数

参数 类型 说明
treatment_name string 待遇名名

请求示例

关闭福利

{
    "name": "五险一金",
    "label": "五险一金的注释"
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 福利待遇(Welfare:Object)列表

Welfare:Object福利

参数 类型 说明
id int
welfare_name string 待遇名名
welfare_label string 待遇注释
active boolean 是否激活
created_time int 创建时间
updated_time int 修改时间

返回示例

{
    "status": 0,
    "data": {
            "id": 7,
            "welfare_name": "餐补",
            "welfare_label": "每天给吃饭",
            "created_time": 1573545197
            "updated_time": 1573545170
        }
}

Status返回值

获取系统中的全部福利待遇信息

获取全部的福利待遇

接口地址

saas/job/config/welfare

请求方式

GET

请求参数

参数 类型 说明
search string 名名

请求示例

支持name模糊查询

{"search""a", }

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array 福利待遇(Welfare:Object)列表

Welfare:Object福利

参数 类型 说明
id int
welfare_name string 待遇名名
welfare_label string 待遇注释
active boolean 是否激活
created_time int 创建时间
updated_time int 修改时间

返回示例

{
    "status": 0,
    "list": [
        {
            "id": 7,
            "welfare_name": "餐补",
            "welfare_label": "每天给吃饭",
            "created_time": 1573545197
            "updated_time": 1573545170
        },
        {
            "id": 6,
            "welfare_name": "五险一金",
            "welfare_label": "给员工交五险一金",
            "created_time": 1573545197
            "updated_time": 1573545170
        }
    ]
}

Status返回值

查看某一个福利待遇的属性

查看福利待遇属性

接口地址

saas/job/config/welfare/{id}

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 福利待遇(Welfare:Object)列表

Welfare:Object福利

参数 类型 说明
id int
welfare_name string 待遇名名
welfare_label string 待遇注释
active boolean 是否激活
created_time int 创建时间
updated_time int 修改时间

返回示例

{
    "status": 0,
    "data": {
            "id": 7,
            "welfare_name": "餐补",
            "welfare_label": "每天给吃饭",
            "created_time": 1573545197
            "updated_time": 1573545170
        }
}

Status返回值

修改编辑某一个福利待遇的属性

查看福利待遇属性

接口地址

saas/job/config/welfare/{id}

请求方式

PUT

请求参数

参数 类型 说明
treatment_name string 待遇名名

请求示例

关闭福利

{
    "active_status": false
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 福利待遇(Welfare:Object)列表

Welfare:Object福利

参数 类型 说明
id int
welfare_name string 待遇名名
welfare_label string 待遇注释
active boolean 是否激活
created_time int 创建时间
updated_time int 修改时间

返回示例

{
    "status": 0,
    "data": {
            "id": 7,
            "welfare_name": "餐补",
            "welfare_label": "每天给吃饭",
            "created_time": 1573545197
            "updated_time": 1573545170
        }
}

Status返回值

标签 company:label

删除多个标签

接口地址

saas/job/company/label

请求方式

DELETE

请求参数

参数 类型 说明
label_list array 里面是标签的id

请求示例

{
    "label_list" : [9,8]
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
affect int 受影响的数量

返回示例

{
    "status":0,
    "affect": 2
}

Status返回值

status 说明
201 id错误

Status返回值

Log

日期 作者 内容
2021/09/13 李世星 新增

新增一个标签

新增一个标签

接口地址

saas/job/company/label

请求方式

POST

请求参数

参数 类型 说明
label_name string 标签名

请求示例

新增标签

{
    "label_name": "本科"
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 新增标签 Label:Object

Label:Object标签

参数 类型 说明
id int 标签ID
label_name string 标签名

返回示例

{
    "status": 0,
    "data": {
            "id": 7,
            "label_name": "本科"
        }
}

Status返回值

Log

日期 作者 内容
2021/09/13 李世星 新增

获取公司标签

获取全部的公司标签

接口地址

saas/job/company/label

请求方式

GET

请求参数

参数 类型 说明
search string 名称

请求示例

支持name模糊查询

{"search": "a"}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array 公司标签(Label:Object)列表

Label:Object标签

参数 类型 说明
id int 标签ID
label_name string 标签名称

返回示例

{
    "status": 0,
    "list": [
        {
            "id": 7,
            "label_name": "本科"
        },
        {
            "id": 6,
            "label_name": "光学显示"
        }
    ]
}

Status返回值

Log

日期 作者 内容
2021/09/13 李世星 新增

查看某一个标签

查看标签遇属性

接口地址

saas/job/company/label/{id}

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 公司标签(Label:Object)

Label:Object标签

参数 类型 说明
id int 标签ID
label_name string 标签名称

返回示例

{
    "status": 0,
    "data": {
            "id": 7,
            "label_name": "本科"
        }
}

Status返回值

Log

日期 作者 内容
2021/09/13 李世星 新增

修改编辑某一个标签的属性

修改编辑某一个标签属性

接口地址

saas/job/company/label/{id}

请求方式

PUT

请求参数

参数 类型 说明
label_name string 标签名称

请求示例

{
    "label_name": "硕士"
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 标签(Label:Object)列表

Label:Object标签

参数 类型 说明
id int
label_name string 标签名称

返回示例

{
    "status": 0,
    "data": {
            "id": 7,
            "label_name": "本科"
        }
}

Status返回值

Log

日期 作者 内容
2021/09/13 李世星 新增

职能分类 config:field

修改一个职能分类的属性

接口地址

saas/job/config/field/{id}

请求方式

PUT

请求参数

BODY

参数 类型 说明
field_name string 职能的名字
active_status bool 启用就不能关闭了

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 分类(field:Object)列表

field:Object分类

参数 类型 说明
id int
name string 职能名称
active_status int 是否激活

返回示例

{
    "status": 0,
    "data": {
        "id": 71,
        "name": "名称asd",
        "active_status": true
    }
}

Status返回值

status 说明
201 id错误

修改一个职能的属性

修改智能的时候,需要指明所属智能的分类id

接口地址

saas/job/config/function/{id}

请求方式

PUT

请求参数

BODY

参数 类型 说明
position_name string 职能的名字
field_id int 分类ID

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 分类(function:Object)列表

function:Object分类

参数 类型 说明
id int
name string 职能名称
active_status int 是否激活
owner object owner:Object
filed object field:Object

field:Object分类

参数 类型 说明
id int
name string 名名

owner:Object分类

参数 类型 说明
id int
name string 创建者

返回示例

{
    "status":0,
    "data":{
            "id":7,
            "name":"工程师",
            "active_status":false,
            "owner":{
                "manager_id":1,
                "manager_name":"XXX"
            },
            "filed":{
                "filed_id":1,
                "filed_name":"半导体"
            },
            "created_time":1573545197,
            "updated_time":1573545170
    }
}

Status返回值

status 说明
201 id错误

删除多个分类

接口地址

saas/job/config/field

请求方式

DELETE

请求参数

参数 类型 说明
field_list array 里面是职位的id

请求示例

{
    "field_list" : [9,8]
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
affect int 受影响的数量

返回示例

{
    "status":0,
   "affect": 2
}

Status返回值

status 说明
201 id错误

新增一个新的职能

新增智能的时候,需要指明所属智能的分类id

接口地址

saas/job/config/function

请求方式

POST

请求参数

BODY

参数 类型 说明
position_name string 职能的名字
field_id int 分类ID

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 分类(function:Object)列表

function:Object分类

参数 类型 说明
id int
name string 职能名称
active_status int 是否激活
owner object owner:Object
filed object field:Object

field:Object分类

参数 类型 说明
id int
name string 名名

owner:Object分类

参数 类型 说明
id int
name string 创建者

返回示例

{
    "status":0,
    "data":{
            "id":7,
            "name":"工程师",
            "active_status":false,
            "owner":{
                "manager_id":1,
                "manager_name":"XXX"
            },
            "filed":{
                "filed_id":1,
                "filed_name":"半导体"
            },
            "created_time":1573545197,
            "updated_time":1573545170
    }
}

Status返回值

status 说明
201 id错误

查看职能所拥有的分类信息

获取全部的职能先关分类

接口地址

saas/job/config/field

请求方式

POST

请求参数

参数 类型 说明
field_name string 名名
active_status bool 是否启用

请求示例

{
    "field_name": "a",
    "active_status": true
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array 分类(field:Object)列表

field:Object分类

参数 类型 说明
id int
name string 名名

返回示例

{
    "status":0,
    "data":{
            "id":6,
            "name":"五险一金",
            "active_status":false,

        }
}

Status返回值

查看一个职能的属性

以职能肯定是有一个所属的分类的

接口地址

saas/job/config/function/{id}

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 分类(function:Object)列表

function:Object分类

参数 类型 说明
id int
name string 职能名称
active_status int 是否激活
owner object owner:Object
filed object field:Object

field:Object分类

参数 类型 说明
id int
name string 名名

owner:Object分类

参数 类型 说明
id int
name string 创建者

返回示例

{
    "status":0,
    "data":{
            "id":7,
            "name":"工程师",
            "active_status":false,
            "owner":{
                "manager_id":1,
                "manager_name":"XXX"
            },
            "filed":{
                "filed_id":1,
                "filed_name":"半导体"
            },
            "created_time":1573545197,
            "updated_time":1573545170
    }
}

Status返回值

status 说明
201 id错误

查看职能所拥有的分类信息

获取全部的职能先关分类

接口地址

saas/job/config/field

请求方式

GET

请求参数

query

参数 类型 说明
search string 名称
detail int 如果是1则返回详细的列表用接口数据,否则是简化的不能分页的数据
page int 页码

请求示例

支持name模糊查询

saas/job/config/field?detail=1&page=1

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array 分类(field:Object)列表

field:Object分类

参数 类型 说明
id int
name string 名名
overview string 注释
active_status boolean 是否激活
owner string 用户名称
created_time int 创建时间
updated_time int 修改时间

返回示例

{
    "status": 0,
    "data": [
        {
            "id": 80,
            "name": "分类6",
            "owner": "kji",
            "status": false,
            "positions": [
                {
                    "id": 45,
                    "name": "请求切去去去1",
                    "owner": "kji",
                    "status": true,
                    "created_time": 1587463678
                }
            ],
            "created_time": 1587533344
        },
        {
            "id": 79,
            "name": "分类6",
            "owner": "kji",
            "status": false,
            "positions": [],
            "created_time": 1587533295
        },
        {
            "id": 78,
            "name": "分类6",
            "owner": "kji",
            "status": false,
            "positions": [],
            "created_time": 1587533235
        },
        {
            "id": 77,
            "name": "分类5",
            "owner": "kji",
            "status": false,
            "positions": [],
            "created_time": 1587532603
        },
        {
            "id": 76,
            "name": "分类4",
            "owner": "kji",
            "status": true,
            "positions": [],
            "created_time": 1587532581
        },
        {
            "id": 75,
            "name": "分类3",
            "owner": "kji",
            "status": true,
            "positions": [],
            "created_time": 1587532563
        },
        {
            "id": 74,
            "name": "分类2",
            "owner": "kji",
            "status": false,
            "positions": [],
            "created_time": 1587454947
        },
        {
            "id": 73,
            "name": "分类1",
            "owner": "kji",
            "status": true,
            "positions": [
                {
                    "id": 46,
                    "name": "艰苦艰苦就能看见你可能",
                    "owner": "kji",
                    "status": true,
                    "created_time": 1587463723
                }
            ],
            "created_time": 1587454918
        },
        {
            "id": 71,
            "name": "名称5421@@@~!!!!",
            "owner": "测试账号",
            "status": true,
            "positions": [
                {
                    "id": 48,
                    "name": "看看就很快就会",
                    "owner": "kji",
                    "status": true,
                    "created_time": 1587463814
                },
                {
                    "id": 49,
                    "name": "i解耦i加哦加哦就",
                    "owner": "kji",
                    "status": true,
                    "created_time": 1587463866
                }
            ],
            "created_time": 1587450678
        },
        {
            "id": 69,
            "name": "22222222",
            "owner": "熊文强",
            "status": true,
            "positions": [
                {
                    "id": 40,
                    "name": "ceshi",
                    "owner": "测试账号",
                    "status": false,
                    "created_time": 1587440702
                },
                {
                    "id": 44,
                    "name": "新的测!!试",
                    "owner": "测试账号",
                    "status": true,
                    "created_time": 1587452673
                },
                {
                    "id": 47,
                    "name": "节目离开家离开家",
                    "owner": "kji",
                    "status": true,
                    "created_time": 1587463782
                }
            ],
            "created_time": 1587435047
        }
    ]
}

Status返回值

职位 position

查看职位详情接口

接口地址

/saas/job/position/{id}

请求方式

GET

请求参数

参数 类型 说明 必填
id int 职位主键id

请求示例

获取主键id为1的职位详情
/api/saas/job/position/1

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 数据对象

list:Object 数据列表

参数 类型 说明
id int 主键id
customer_id int oms客户id
customer_member_id int 发布人(客户下成员账号id)
company_id int 基本信息id(0为非猎头,是取oms客户信息)
name string 职位名称
position_id in 职能分类id
province string
city string 市(工作地点)
county string
years int 要求工作年限(0为应届生,单位年)
educ string 学历要求
salary_min int 薪资最小值(万/年)
salary_max int 薪资最大值(万/年)
intro int 职位描述500字
delivery_num int 投递人数
comment_num int 评论数
view_num int 观看数
collect_num int 收藏数
status int 状态(默认1正常,0暂停)
company_name string 公司名称
logo string 公司LOGO
capitalization string 融资阶段
scale string 公司规模
treatment_ids string 公司福利ID(多个逗号隔开)
overview string 公司简介
display_name string 猎头对外显示名称
updated_at int 更新时间
created_at int 创建时间

返回示例

{
  "status": 0,
  "data": {
    "id": 1,
    "customer_id": "oms客户id",
    "customer_member_id": "oms客户下成员id",
    "company_id": "公司信息id",
    "name": "职位名称",
    "position_id": "职能分类id",
    "province": "省",
    "city": "市(工作地点)",
    "county": "区",
    "years": "要求工作年限(0为应届生,单位年)",
    "educ": "学历要求",
    "salary_min": "薪资最小值(万/年)",
    "salary_max": "薪资最大值(万/年)",
    "intro": "职位描述最多500字",
    "delivery_num": "投递人数",
    "comment_num": "评论数",
    "view_num": "观看数",
    "collect_num": "收藏数",
    "status": "状态(默认1正常,0暂停)",
    "updated_at": 1584519571,
    "created_at": 1584374400,
    "company_info": {
      "id": 1,
      "customer_id": "oms客户id",
      "company_name": "公司名称",
      "logo": "公司LOGO",
      "capitalization": "融资阶段",
      "scale": "公司规模",
      "overview": "公司简介",
      "province": "省",
      "city": "市",
      "county": "区",
      "address": "详细地址",
      "display_name": "猎头对外显示名称",
      "is_hunter": "(true是猎头,false不是)",
      "status": 1,
      "updated_at": 1584435651,
      "created_at": 1583402734,
      "treatment_list": [
        {
          "id": 2,
          "name": "福利名称",
          "overview": "福利介绍",
          "status": "状态(默认1正常,0删除)",
          "owner_id": "上传拥有者ID",
          "created_at": 1584460800,
          "updated_at": 1584460800
        }
      ]
    },
    "comment_list": [
      {
        "id": "评论id",
        "res_type": "资源类型(1:对职位评论,2对评论评论)",
        "res_id": "对应的资源id(目前只能对职位评论)",
        "content": "评论内容",
        "like_num": "评论点赞数量",
        "user_id": "评论用户",
        "to_user_id": "被评论的用户id(只有评论评论才会有值)",
        "ip": "评论用户IP地址",
        "source": "来源",
        "status": "状态:0-审核失败,1-审核中,2-通过",
        "updated_at": 1584503487,
        "created_at": 1583352428,
        "user_info": {
          "id": 1,
          "nickname": "评论人昵称"
        }
      }
    ],
    "position_info": {
      "id": "职能标签表主键id",
      "name": "职能标签名称",
      "overview": "介绍",
      "status": "启用状态 (1 :启用 0 :废弃)",
      "owner_id": "上传拥有者ID",
      "field_id": "父极职能分类id",
      "created_at": 1583856000,
      "updated_at": 1584673240,
      "field_info": {
        "id": "父极职能分类主键id",
        "name": "职能分类名称",
        "status": "启用状态 (1 :启用 0 :废弃)",
        "owner_id": "上传拥有者ID",
        "created_at": 1583856000,
        "updated_at": 1583909034
      }
    },
    "customer_member_info": {
      "id": 1,
      "nickname": "发布人昵称"
    }
  }
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

职位下的简历列表接口

接口地址

/saas/job/cv

请求方式

GET

请求参数

参数 类型 说明(如果一起传多个则会都满足的情况才会返回结果,如果不想搜索某条件,则不传该参数) 必填
page int 第几页
limit int 条数
position_id int 职位主键id

请求示例

职位id为1下的简历投递列表
/api/saas/job/cv?position_id=1

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list object 数据列表
paginate object 分页信息

list:Object 数据列表

参数 类型 说明
id int 主键id
user_id int 用户id
field_id int 职能分类
years int 工作年限(0为应届生,单位年)
job_status int 求职状态(默认1离职,2在职月内到岗,3在职考虑机会,4在职暂不考虑)
educ string 学历
salary int 目前薪资(单位:万/年)
name string 姓名
sex int 性别(1男,2女)
age int 年龄
school string 高校名称
major string 专业名称
tel string 联系电话
email string 电子邮箱
position_id int 目前职位
wish_info array 期望信息
wish_field_ids array 期望信息:期望职能id,最多选5个
wish_position_id int 期望信息:期望职位id
wish_salary int 期望信息:期望薪水(单位:万/年)
wish_city string 期望信息:期望地点(城市)
intro string 自我评价
project_info array 工作经验
start_time int 工作经验:开始时间
end_time int 工作经验:结束时间
company string 工作经验:公司名称
position_id int 工作经验:职位
project string 工作经验:工作内容及项目经验
educ_info array 教育经历
start_time int 教育经历:开始时间
end_time int 教育经历:结束时间
school string 教育经历:学校
major string 教育经历:专业
educ string 教育经历:学历
full_time int 教育经历:是否全日制(0否,1是)
status int 状态(默认1全部不可见,2全部可见,3HR可见,4猎头可见)
download_num int 下载次数
remark string 其他信息
updated_at int 更新时间
created_at int 创建时间

paginate:Object 分页信息

参数 类型 说明
current_page int 当前页码
first_page_url string 第一页url
last_page int 总页数
last_page_url string 最后一页url
next_page_url string 下一页url
path string 当前页url
per_page int 一页多少条
total int 总条数

返回示例

{
  "status": 0,
  "list": [
    {
      "id": "简历表主键id",
      "name": "eric",
      "name": "姓名",
      "sex": "性别(1男,2女)",
      "age": "年龄",
      "tel": "手机号",
      "email": "邮箱",
      "avatar": "头像",
      "intro": "自我评价",
      "job_status": "求职状态(默认1离职找工作,2在职暂不考虑,3在职考虑机会",
      "status": "状态(默认1全部不可见,2全部可见,3HR可见,4猎头可见)",
      "download_num": "下载数",
      "province": "省",
      "city": "市",
      "county": "区",
      "years": "工作年限(0为应届生,单位月)",
      "salary": "目前薪资(单位:万/年)",
      "school": "清华大学",
      "major": "软件工程",
      "remark": "备注信息",
      "updated_at": "修改时间戳",
      "created_at": "创建时间戳",
      "wish_list": [
        {
          "id": "求职意向表主键id",
          "wish_province": "期望省",
          "wish_city": "期望市工作地点",
          "wish_county": "期望区",
          "wish_salary": "期望薪资(单位:万/年)",
          "wish_position_name": "期望职位名称",
          "status": "状态,1正常,0删除",
          "updated_at": 1583845603,
          "created_at": 1583769600,
          "position_list": [
            {
              "id": "职能标签主键id",
              "name": "职能标签名",
              "overview": "介绍",
              "status": "启用状态 (1 :启用 0 :废弃)",
              "owner_id": "上传拥有者ID",
              "field_id": "父极职能分类id",
              "created_at": 1583856000,
              "updated_at": 1584673240,
              "field_info": {
                "id": "父极职能分类主键id",
                "name": "职能分类名称",
                "status": "启用状态 (1 :启用 0 :废弃)",
                "owner_id": "上传拥有者ID",
                "created_at": 1583856000,
                "updated_at": 1583909034
              }
            }
          ]
        }
      ],
      "project_list": [
        {
          "id": "工作经验表主键id",
          "start_time": "开始时间",
          "end_time": "结束时间,如果为1则是至今",
          "company_id": "公司id(有值代表在我们的公司表里)",
          "company": "公司名",
          "job_position_id": "所属职能标签表id",
          "position_name": "职位名称",
          "project": "工作经验",
          "status": "状态(默认1正常,0删除)",
          "is_hidden": "是否对该公司隐藏(1是,0否)",
          "updated_at": 1584694291,
          "created_at": 1583769600,
          "position_info": {
            "id": "职能标签表主键id",
            "name": "职能标签名称",
            "overview": "介绍",
            "status": "启用状态 (1 :启用 0 :废弃)",
            "owner_id": "上传拥有者ID",
            "field_id": "父极职能分类id",
            "created_at": 1583856000,
            "updated_at": 1584673240,
            "field_info": {
              "id": "父极职能分类主键id",
              "name": "职能分类名称",
              "status": "启用状态 (1 :启用 0 :废弃)",
              "owner_id": "上传拥有者ID",
              "created_at": 1583856000,
              "updated_at": 1583909034
            }
          }
        }
      ],
      "educ_list": [
        {
          "id": "教育经历表主键id",
          "start_time": "开始时间戳",
          "end_time": "结束时间戳",
          "educ": "学历(0应届生,1大专,2本科,3硕士,4博士,5MBA)",
          "school": "学校",
          "major": "专业",
          "full_time": "是否全日制(0否,1是)",
          "status": "状态,1正常,0删除",
          "updated_at": 1583839721,
          "created_at": 1583769600
        }
      ]
    }
  ],
  "current_page": "当前页码",
  "last_page": "总页数",
  "per_page": "一页多少条",
  "total": "总条数"
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/27 李世星 修改简历列表接口 新增参数(school学校名称)(major专业名称)

职位列表及搜索接口

接口地址

/saas/job/position

请求方式

GET

请求参数

参数 类型 说明(如果一起传多个则会都满足的情况才会返回结果,如果不想搜索某条件,则不传该参数,类型为array多选的用body形式传参) 必填
page int 第几页
position_name string 模糊搜索职位名称
company_name string 模糊搜索公司名称
is_top int 是否置顶(1为置顶,2为未置顶)
years int 职能类别 1双选会 2为非双选会
status int 状态搜索(1正常,2暂停)不传查所有
salary_min int 搜索薪资最小值
salary_max int 搜索薪资最大值
treatment_ids array 搜索福利待遇,支持多选[1,2,3]
limit int 每页条数
field_position array 搜索分类职能,json数组形式[[2,0],[1,1],[3,0]],支持多选最多选中标签5个, 二维数组中第一个值是分类id(注意:第一个值不能为0,否则抛出异常),第二个值是职能id

请求示例

搜索职位包含PHP的
/api/saas/job/position?position_name="php"

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list object 数据列表
paginate object 分页信息

list:Object 数据列表

参数 类型 说明
id int 主键id
customer_id int oms客户id
customer_member_id int 发布人(客户下成员账号id)
company_id int 基本信息id(0为非猎头,是取oms客户信息)
name string 职位名称
position_id in 职能分类id
province string
city string 市(工作地点)
county string
years int 要求工作年限(0为应届生,单位年)
educ string 学历要求
salary_min int 薪资最小值(万/年)
salary_max int 薪资最大值(万/年)
intro int 职位描述500字
delivery_num int 投递人数
comment_num int 评论数
view_num int 观看数
collect_num int 收藏数
status int 状态(默认1正常,0暂停)
company_name string 公司名称
logo string 公司LOGO
capitalization string 融资阶段
scale string 公司规模
treatment_ids string 公司福利ID(多个逗号隔开)
overview string 公司简介
display_name string 猎头对外显示名称
company _province string
company _city string
company _county string
address string 公司详细地址
is_top int 1为置顶0为未置顶
updated_at int 更新时间
created_at int 创建时间

paginate:Object 分页信息

参数 类型 说明
current_page int 当前页码
first_page_url string 第一页url
last_page int 总页数
last_page_url string 最后一页url
next_page_url string 下一页url
path string 当前页url
per_page int 一页多少条
total int 总条数

返回示例

{
  "status": 0,
  "list": [
    {
      "id": 1,
      "customer_id": "oms客户id",
      "customer_member_id": "oms客户下成员id",
      "company_id": "公司信息id",
      "name": "职位名称",
      "job_position_id": "所属职能标签表id",
      "years": "要求工作年限(0不限,1应届生,2、1~3年,3、3~5年,4、5~10年,5、10年以上)",
      "educ": "学历要求(0不限,1大专,2本科,3硕士,4博士,5MBA)",
      "salary_min": "薪资最小值(万/年)",
      "salary_max": "薪资最大值(万/年)",
      "intro": "职位描述最多500字",
      "delivery_num": "投递人数",
      "comment_num": "评论数",
      "view_num": "观看数",
      "collect_num": "收藏数",
      "status": "状态(默认1正常,0暂停)",
      "updated_at": 1584519571,
      "created_at": 1584374400,
      "province": "省",
      "city": "市",
      "field_position": "互联网软件 - php开发",
      "company_info": {
        "id": 1,
        "customer_id": "oms客户id",
        "company_name": "公司名称",
        "logo": "公司LOGO",
        "capitalization": "融资阶段",
        "scale": "公司规模",
        "overview": "公司简介",
        "display_name": "猎头对外显示名称",
        "status": 1,
        "updated_at": 1584435651,
        "created_at": 1583402734,
        "treatment_list": [
          {
            "id": 2,
            "name": "福利名称",
            "overview": "福利介绍",
            "status": "状态(默认1正常,0删除)",
            "owner_id": "上传拥有者ID",
            "is_top": 1,
            "created_at": 1584460800,
            "updated_at": 1584460800
          }
        ]
      },
      "position_info": {
        "id": "职能标签表主键id",
        "name": "职能标签名称",
        "overview": "介绍",
        "status": "启用状态 (1 :启用 0 :废弃)",
        "owner_id": "上传拥有者ID",
        "field_id": "父极职能分类id",
        "created_at": 1583856000,
        "updated_at": 1584673240,
        "field_info": {
          "id": "父极职能分类主键id",
          "name": "职能分类名称",
          "status": "启用状态 (1 :启用 0 :废弃)",
          "owner_id": "上传拥有者ID",
          "is_top": 0,
          "created_at": 1583856000,
          "updated_at": 1583909034
        }
      }
    }
  ],
  "total": 8,
  "current_page": 1,
  "last_page": 8,
  "per_page": 1
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/27 李世星 修改 新增is_top 置顶参数 years 职能查询类别

修改职位置顶接口

接口地址

/saas/job/position/{id}/top

请求方式

PUT

请求参数

参数 类型 说明 必填
is_top int 是否置顶 1为置顶0为取消置顶

请求示例

修改职位置顶接口
curl --location -g --request PUT '/saas/job/position/{id}/top' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbMV0sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTYzNTgzOTkxNSwiZXhwIjoxNjM2NDQ0NzE1fQ.MHcaByL7YDkSrgL4ZWGlfwCBz_okE_l9fvaWR_OYEUg' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'is_top=1'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 数据

data:object 数据类型

参数 类型 说明
id int 职位id
is_top int 是否置顶(0为未置顶1为置顶)
updated_at int 修改时间

返回示例

{
  "status": 0,
  "error": "",
  "data": {
    "id": 1,
    "is_top": 1,
    "updated_at": 1542514212
  }
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/27 李世星 新增

职位列表及搜索接口

接口地址

/saas/job/position/comment/{id}

请求方式

GET

请求参数

参数 类型 说明(如果一起传多个则会都满足的情况才会返回结果,如果不想搜索某条件,则不传该参数) 必填
page int 第几页
limit int 条数(默认3条)

请求示例

职位id为1的第二页,每页3条评论
/api/saas/job/position/comment/1?page=2&limit=3

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list object 数据列表
paginate object 分页信息

list:Object 数据列表

参数 类型 说明
id int 主键id
user_id int 评论人id
content string 评论内容
like_num int 评论点赞数量
to_user_id int 被评论的用户id(只有评论评论才会有值)
status int 0-审核失败,1-审核中,2-通过
updated_at int 更新时间
created_at int 创建时间

paginate:Object 分页信息

参数 类型 说明
current_page int 当前页码
first_page_url string 第一页url
last_page int 总页数
last_page_url string 最后一页url
next_page_url string 下一页url
path string 当前页url
per_page int 一页多少条
total int 总条数

返回示例

{
  "status": 0,
  "list": [
    {
      "id": "评论主键id",
      "res_type": "资源类型(1:对职位评论,2对评论评论)",
      "res_id": "对应资源id",
      "content": "评论内容",
      "like_num": "评论点赞数量",
      "user_id": "评论用户",
      "to_user_id": "被评论用户",
      "ip": "评论用户IP地址",
      "source": "来源",
      "status": "0-审核失败,1-审核中,2-通过",
      "updated_at": 1585020802,
      "created_at": 1583352428,
      "user_info": {
        "id": 1,
        "nickname": "123"
      }
    },
    {
      "id": 10,
      "res_type": 1,
      "res_id": 1,
      "content": "评论内容",
      "like_num": 0,
      "user_id": 1,
      "to_user_id": 0,
      "ip": "评论用户IP地址",
      "source": "来源",
      "status": 1,
      "updated_at": 1585020804,
      "created_at": 1583352428,
      "user_info": {
        "id": 1,
        "nickname": "123"
      }
    }
  ],
  "total": 5,
  "current_page": 2,
  "last_page": 2,
  "per_page": "3"
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

设置职位置顶

接口地址

/api/saas/job/position/{positionId}/top

请求方式

PUT

RequestBody

请求参数

参数 类型 说明 必填
is_top int 是否置顶 1为置顶0为取消置顶

请求示例

curl --location --request PUT '/api/saas/job/position/274/top' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbM10sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTY0NTU4Mjg1NSwiZXhwIjoxNjQ2MTg3NjU1fQ.5K2Q6P8-_tUZeKw_O4JeKnf77dSgQcwsXFyuFSUXhxw' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'is_top=0'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 修改职位详情

data:Object 数据列表

参数 类型 说明
id int 修改的职位id

返回示例

{
    "status": 0,
    "data": {
        "id": 274
    }
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/02/24 李世星 新增

获取职位类型

接口地址

/api/saas/job/position/types

请求方式

GET

RequestBody

请求参数

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data array 修改职位详情

data:Array 数据列表

参数 类型 说明
id int 类型id
name int 类型名称
identify int 类型标识

返回示例

{
  "status": 0,
  "data": [
    {
      "id": 0,
      "name": "全部",
      "identify": "all"
    },
    {
      "id": 2,
      "name": "实习",
      "identify": "SHIXI"
    },
    {
      "id": 1,
      "name": "校招",
      "identify": "XIAOZHAO"
    },
    {
      "id": 3,
      "name": "社招",
      "identify": "SHEZHAO"
    }
  ]
}

Log

日期 作者 内容
2022/07/13 李晓东 新增

双选会 job_share

获取双选会活动列表

接口地址

/saas/job_share/activity

请求方式

GET

请求参数

参数 类型 说明 必填
state int( 0为关闭1为可用) 可用

请求示例

获取双选会活动
curl --location --request GET '/api/saas/job_share/activity?state=1' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbMV0sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTYzNTgzOTkxNSwiZXhwIjoxNjM2NDQ0NzE1fQ.MHcaByL7YDkSrgL4ZWGlfwCBz_okE_l9fvaWR_OYEUg'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list object 数据列表

list:Object 数据列表

参数 类型 说明
code string 活动Code码
background_url string 小程序背景图片
background_color string 小程序背景颜色
state int 状态 1为可用 0为关闭
created_at int 创建时间
{
  "status": 0,
  "error": "",
  "list": [
    {
      "code": "d3c7e33f",
      "background_url": "http://xxxx.com.cn/xxxx.jpg",
      "background_color": "#ffff",
      "state": 1,
      "created_at": 154213251
    }
  ]
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/25 李世星 新增

获取双选会活动详情

接口地址

/saas/job_share/activity/{activity_code}

请求方式

GET

请求参数

请求示例

获取双选会活动
curl --location --request GET '/api/saas/job_share/activity/d3c7e33f' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbMV0sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTYzNTgzOTkxNSwiZXhwIjoxNjM2NDQ0NzE1fQ.MHcaByL7YDkSrgL4ZWGlfwCBz_okE_l9fvaWR_OYEUg'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 数据详情

data:Object 数据详情

参数 类型 说明
code string 活动Code码
background_url string 小程序背景图片
background_color string 小程序背景颜色
state int 状态 1为可用 0为关闭
created_at int 创建时间
{
    "status": 0,
    "error": "",
    "list": {
        "code": "d3c7e33f",
        "background_url": "http://xxxx.com.cn/xxxx.jpg",
        "background_color": "#ffff",
        "state": 1,
        "created_at": 154213251
    }
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/27 李世星 新增

修改双选会活动信息

接口地址

/saas/job_share/activity/{activityCode}

请求方式

PUT

请求参数

参数 类型 说明 必填
background_url string 小程序主题背景URL
background_color string 小程序主题背景颜色

请求示例

修改双选会活动信息
curl --location --request PUT '/api/saas/job_share/activity/d3c7e33f' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbM10sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTY0MzMzNDA3NCwiZXhwIjoxNjQzOTM4ODc0fQ.qDmgWsNwyWLxvHmCOnsw65eXnItgJNJuQfmIfBgU-uA' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'background_url=http://xxxx.com.cn/xxxxxx.jpg' \
--data-urlencode 'background_color=#ffff'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 数据列表

data:Object 数据列表

参数 类型 说明
code string 活动Code
background_url string 小程序背景图片
background_color string 小程序背景颜色
state int 状态 1为可用 0为关闭
created_at int 创建时间
updated_at int 修改时间

返回示例

{
    "status":0,
    "data":
    {
        "code": "d3c7e33f",
        "background_url": "http://xxxx.xxxxxxxxx.com.cn/uploads/xxxxxxx.jpg",
        "background_color": "#FFFFFF",
        "state": 1,
        "created_at": 1365415242,
        "updated_at": 1365415242
    }
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/25 李世星 新增

获取双选会场次列表

接口地址

/saas/job_share/sites

请求方式

GET

请求参数

参数 类型 说明 必填
page int 第几页
limit int 条数
name string 场地名称
state int 0为下架1为上架

请求示例

获取场地列表
curl --location --request GET '/api/saas/job_share/sites?state=1&page=1&limit=10&name=西安 \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbMV0sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTYzNTgzOTkxNSwiZXhwIjoxNjM2NDQ0NzE1fQ.MHcaByL7YDkSrgL4ZWGlfwCBz_okE_l9fvaWR_OYEUg'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list object 数据列表
paginate object 分页信息

list:Object 数据列表

参数 类型 说明 版本
id int 主键id
name string 场地名称
activity_time string 活动时间
address string 地址详情
state int 上架状态
sort int 排序号
unit_id int unit Id 2022 10月份 迭代
unit_name string 报名模板 名称
is_hot bool 是否是热门

paginate:Object 分页信息

参数 类型 说明
current_page int 当前页码
last_page int 总页数
per_page int 一页多少条
total int 总条数

返回示例

{
  "status": 0,
  "current_page": 1,
  "last_page": 2,
  "total": 19,
  "per_page": 10,
  "list": [
    {
      "id": 16,
      "name": "123412",
      "address": "1234",
      "state": 0,
      "sort": 10001,
      "is_hot": false,
      "unit_id": 0,
      "unit_name": "",
      "activity_time": "2022.07.06 10:03-2022.03.31 00:00"
    }
  ]
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/25 李世星 新增
2022/07/13 李晓东 编辑

双选会场地详情

接口地址

/saas/job_share/sites/{siteId}

请求方式

GET

请求参数

请求示例

场地详情
curl --location --request GET '/api/saas/job_share/sites/1' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbMV0sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTYzNTgzOTkxNSwiZXhwIjoxNjM2NDQ0NzE1fQ.MHcaByL7YDkSrgL4ZWGlfwCBz_okE_l9fvaWR_OYEUg'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 场地详情

data:Object 场地详情

| 参数 | 类型 | 说明 | 版本| |---|---|---| | id | int | 主键id | | name|string|场地名称| | start_time|int|活动开始时间| | end_time|int|活动结束时间| | activity_time|string|活动时间| | address|string|地址详情| | state|int|上架状态| | sort|int|排序号| | h5_background_url|string|小程序宣传图| | pc_background_url|string|pc宣传图| | h5_background_color|string|小程序宣传背景颜色| | pc_background_color|string|pc宣传背景颜色| | unit_id | int| 相关unitId|2022 10月份 迭代 | | theme | int| 双选会主题| | link|string|跳转连接| | cover|string|封面图| | created_at|int|创建时间| | updated_at|int|修改时间|

返回示例

{
    "status":0,
    "data": {
        "id": 1,
        "name": "西安场",
        "start_time": 1542356982,
        "end_time": 1542356982,
        "activity_time": "2021.11.4 18:00-21:00",
        "address": "东南大学九龙湖校区",
        "state": 1,
        "sort": 1,
        "h5_background_url": "http://xxx.xxx.com.cn/uploads/xxxx.jpg",
        "pc_background_url": "http://xxx.xxx.com.cn/uploads/xxxx.jpg",
        "h5_background_color": "#FFFFFF",
        "pc_background_color": "#FFFFFF",
        "unit_id": 104,
        "link": "http://xxx.xxx.com.cn/uploads/xxxx",
        "cover": "http://xxx.xxx.com.cn/uploads/xxxx",
        "created_at": 1542356982,
        "updated_at": 1542356982
    }
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/25 李世星 新增
2022/01/25 李晓东 编辑
2022/09/06 李晓东 新增加theme字段

获取双选会相关(报名模板)

接口地址

/api/saas/job_share/sites/apply

请求方式

GET

请求参数

请求示例

获取双选会相关报名模板
curl --location --request GET '/api/saas/job_share/sites/apply' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbM10sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTY0NTU4Mjg1NSwiZXhwIjoxNjQ2MTg3NjU1fQ.5K2Q6P8-_tUZeKw_O4JeKnf77dSgQcwsXFyuFSUXhxw' \

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list Object 报名模板列表

list:Object 数据列表

参数 类型 说明 版本
id int 2022 10月份 迭代
name int 报名模板名称 2022 10月份 迭代
template_id string 模板id 2022 10月份 迭代
apply_page_id int 相关报名页id 2022 10月份 迭代
author int 用户创建者id 2022 10月份 迭代
status boolean 报名模板状态 1为上线 0为下线 2022 10月份 迭代
bind_status boolean 报名模板绑定状态 1为绑定 0为未绑定 2022 10月份 迭代
type boolean 报名模板类别 1为学生报名模板 2企业报名模板 2022 10月份 迭代
created_at string 创建时间 2022 10月份 迭代
updated_at boolean 更新时间 2022 10月份 迭代
apply_page boolean 相关的报名页 2022 10月份 迭代

apply_page

参数 类型 说明 版本
id int 2022 10月份 迭代
name int 报名页名称 2022 10月份 迭代
author int 创建者id 2022 10月份 迭代
option_count int 表单内容个数 2022 10月份 迭代
status int 报名页状态 2022 10月份 迭代
created_at string 创建时间 2022 10月份 迭代
updated_at boolean 更新时间 2022 10月份 迭代

返回示例

{
  "status": 0,
  "list": [
    {
      "id": 1,
      "name": "测试报名模板3",
      "template_id": 2,
      "apply_page_id": 1,
      "author": 0,
      "status": 1,
      "bind_status": 0,
      "type": 1,
      "created_at": 1667292386,
      "updated_at": 1667292386,
      "apply_page": {
        "id": 1,
        "name": "测试报名模板3",
        "author": 0,
        "option_count": 1,
        "status": 0,
        "created_at": 1667292386,
        "updated_at": 1667292386
      }
    }
  ]
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/10/19 李世星 新增

新增双选会场地

接口地址

/saas/job_share/sites

请求方式

POST

请求参数

参数 类型 说明 必填 版本
name string 场地名称
start_time timestamp 开始时间
end_time timestamp 结束时间
address string 地址详情
h5_background_url string h5宣传图地址
pc_background_url string pc宣传图地址
cover string 封面图
unit_id int 相关报名模板Id 2022 10月份 迭代
sort int 排序

请求示例

新增场地
curl --location --request POST 'http://127.0.0.1:8081/api/saas/job_share/sites' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbMV0sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTYzNTgzOTkxNSwiZXhwIjoxNjM2NDQ0NzE1fQ.MHcaByL7YDkSrgL4ZWGlfwCBz_okE_l9fvaWR_OYEUg' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'name=西安场地' \
--data-urlencode 'start_time=20220125142255' \
--data-urlencode 'end_time=20220125142255' \
--data-urlencode 'address=东南大学九龙湖校区' \
--data-urlencode 'h5_background_url=http://xxxxx.com.cn/xxxxx' \
--data-urlencode 'pc_background_url=http://xxxxx.com.cn/xxxxx' \
--data-urlencode 'link=http://xxxxx.com.cn/xxxxx' \
--data-urlencode 'activity_code=d3c7e33f'
--data-urlencode 'unit_id=104'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 场地详情

data:Object 数据列表

参数 类型 说明 版本
id int 主键id
name string 场地名称
start_time int 活动开始时间
end_time int 活动结束时间
activity_time string 活动时间
address string 地址详情
state int 上架状态
sort int 排序号
h5_background_url string 小程序宣传图
pc_background_url string pc宣传图
unit_id int 相关报名Id 2022 10月份 迭代
link string 跳转连接
cover string 封面图
created_at int 创建时间

返回示例

{
    "status":0,
    "data": 
        {
            "id": 1,
            "name": "西安场",
            "start_time": 1542356982,
            "end_time": 1542356982,
            "activity_time": "2021.11.4 18:00-21:00",
            "address": "东南大学九龙湖校区",
            "state": 1,
            "sort": 1,
            "h5_background_url": "http://xxx.xxx.com.cn/uploads/xxxx.jpg",
            "pc_background_url": "http://xxx.xxx.com.cn/uploads/xxxx.jpg",
            "unit_id": 104,
            "link": "http://xxx.xxx.com.cn/uploads/xxxx",
            "cover": "http://xxx.xxx.com.cn/uploads/xxxx",
            "created_at": 1542356982
        }
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/25 李世星 新增

修改双选会场地

接口地址

/saas/job_share/sites/{siteId}

请求方式

PUT

请求参数

参数 类型 说明 必填 版本
id int 场地ID
name string 场地名称
start_time timestamp 开始时间
end_time timestamp 结束时间
address string 地址详情
h5_background_url string h5宣传图地址
pc_background_url string pc宣传图地址
cover string 封面图
state int 是否上架(0为下架1为上架)
sort int 排序号
unit_id int 相关报名模板Id 2022 10月份 迭代

请求示例

新增场地
curl --location --request PUT '/api/saas/job_share/sites' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbMV0sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTYzNTgzOTkxNSwiZXhwIjoxNjM2NDQ0NzE1fQ.MHcaByL7YDkSrgL4ZWGlfwCBz_okE_l9fvaWR_OYEUg' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'id=1' \
--data-urlencode 'name=西安场地' \
--data-urlencode 'start_time=20220125142255' \
--data-urlencode 'end_time=20220125142255' \
--data-urlencode 'address=东南大学九龙湖校区' \
--data-urlencode 'h5_background_url=http://xxxxx.com.cn/xxxxx' \
--data-urlencode 'pc_background_url=http://xxxxx.com.cn/xxxxx' \
--data-urlencode 'link=http://xxxxx.com.cn/xxxxx' \
--data-urlencode 'activity_code=d3c7e33f' \
--data-urlencode 'state=1' \
--data-urlencode 'sort=1' 
--data-urlencode 'unit_id=104' 

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 场地详情

data:Object 数据列表

参数 类型 说明 版本
id int 主键id
name string 场地名称
start_time int 活动开始时间
end_time int 活动结束时间
activity_time string 活动时间
address string 地址详情
state int 上架状态
sort int 排序号
h5_background_url string 小程序宣传图
pc_background_url string pc宣传图
unit_id int 相关报名模板ID 2022 10月份 迭代
link string 跳转连接
cover string 封面图
created_at int 创建时间

返回示例

{
    "status":0,
    "data": 
        {
            "id": 1,
            "name": "西安场",
            "start_time": 1542356982,
            "end_time": 1542356982,
            "activity_time": "2021.11.4 18:00-21:00",
            "address": "东南大学九龙湖校区",
            "state": 1,
            "sort": 1,
            "h5_background_url": "http://xxx.xxx.com.cn/uploads/xxxx.jpg",
            "pc_background_url": "http://xxx.xxx.com.cn/uploads/xxxx.jpg",
            "unit_id": 104,
            "link": "http://xxx.xxx.com.cn/uploads/xxxx",
            "cover": "http://xxx.xxx.com.cn/uploads/xxxx",
            "created_at": 1542356982
        }
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/25 李世星 新增

删除双选会信息

JOB_SHARE_SITE_DELETE

删除双选会信息

DELETE: /api/saas/job_share/sites/1

Response Body:

{
  "status": 0,
  "data": {
    "id": 3,
    "deleted_at": 1657162189
  }
}

HTTP Method

DELETE

HTTP Request

/api/saas/job_share/sites/{id}

Request Parameters Query

Request Parameters Body

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
id CareerTalk ID Number
deleted_at 删除时间 Number

Log

日期 作者 内容
2022/7/13 李晓东 新增

修改双选会热门属性

接口地址

/saas/job_share/sites/{siteId}/hot

请求方式

PUT

请求参数

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 场地详情

data:Object 数据列表

参数 类型 说明
id int 主键id
is_hot bool 是否热门

返回示例

{
  "status": 0,
  "data": {
    "id": 13,
    "is_hot": true
  }
}

Log

日期 作者 内容
2022/07/13 李晓东 新增

场次企业名单列表

接口地址

/saas/job_share/company

请求方式

GET

请求参数

参数 类型 说明 必填
page int 第几页
limit int 条数
name string 场地名称
state int 0为下架1为上架
top int 0为未置顶1为置顶
siteId int 场次ID

请求示例

获取场次企业名单
curl --location --request GET '/api/saas/job_share/company?page=1&limit=10&name=爱集微咨询(厦门)有限公司&state=1&top=1&siteId=12' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbMV0sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTYzNTgzOTkxNSwiZXhwIjoxNjM2NDQ0NzE1fQ.MHcaByL7YDkSrgL4ZWGlfwCBz_okE_l9fvaWR_OYEUg'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list listObject 企业列表
paginate object 分页信息

list:Object 数据列表

参数 类型 说明
id int 主键id
company_id int 企业ID
site_id int 双选会ID
name string 企业名称
post_num int 岗位数
resume_num int 简历数
top_time bool 置顶状态(true为置顶 false为未置顶)

labels:listObject 数据列表

参数 类型 说明
id int 主键id
name string 标签名称

paginate:Object 分页信息

参数 类型 说明
current_page int 当前页码
last_page int 总页数
per_page int 一页多少条
total int 总条数

返回示例

{
  "status": 0,
  "current_page": 1,
  "last_page": 1,
  "total": 6,
  "per_page": 10,
  "list": [
    {
      "id": 272,
      "company_id": 170,
      "site_id": 16,
      "name": "华夏幸福基业投资部",
      "post_num": 0,
      "resume_num": 0,
      "top_time": true
    }
  ]
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/25 李世星 新增
2022/07/13 李晓东 编辑

场次添加企业名单列表

接口地址

/saas/job_share/company/list

请求方式

GET

请求参数

参数 类型 说明 必填
page int 第几页
limit int 条数
name string 场地名称
siteId int 场次ID

请求示例

获取企业名单
curl --location --request GET 'http://127.0.0.1:8081/api/saas/job_share/company/list?page=1&limit=10&name=上海富瀚微电子股份有限公司&siteId=4' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbMV0sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTYzNTgzOTkxNSwiZXhwIjoxNjM2NDQ0NzE1fQ.MHcaByL7YDkSrgL4ZWGlfwCBz_okE_l9fvaWR_OYEUg'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list listObject 场地详情
paginate object 分页信息

list:Object 数据列表

参数 类型 说明
id int 主键id
name string 企业名称
state int 添加状态1为已添加0为未添加
admin_user admin_user object 添加管理员

paginate:Object 分页信息

参数 类型 说明
current_page int 当前页码
last_page int 总页数
per_page int 一页多少条
total int 总条数

admin_user:admin_user object 数据列表

参数 类型 说明
id int 主键id
name string 管理员名称

返回示例

{
    "status":0,
    "error": "",
    "list": [
        {
            "id": 35,
            "name": "爱集微咨询(厦门)有限公司",
            "state": 1,
            "admin_user": {
                "id": 23,
                "name": "admin"
            }
        },
        {
            "id": 36,
            "name": "中星微技术股份有限公司",
            "state": 0,
            "admin_user": null
        }
    ]

}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/26 李世星 新增

场次添加企业

接口地址

/saas/job_share/company

请求方式

POST

请求参数

参数 类型 说明 必填
company_ids string 公司id
siteId int 场次ID

请求示例

为指定场次添加企业
curl --location --request POST '/api/saas/job_share/company' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbMV0sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTYzNTgzOTkxNSwiZXhwIjoxNjM2NDQ0NzE1fQ.MHcaByL7YDkSrgL4ZWGlfwCBz_okE_l9fvaWR_OYEUg' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'company_ids=36' \
--data-urlencode 'siteId=4'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list Object 添加企业列表

list:Object 数据列表

参数 类型 说明
id int 主键id
name string 企业名称
state int 添加状态1为已添加0为未添加
admin_user admin_user object 添加管理员
created_at int 添加时间

返回示例

{
    "status":0,
    "error": "",
    "list": [
        {
            "id": 35,
            "name": "爱集微咨询(厦门)有限公司",
            "state": 1,
            "admin_user": {
                "id": 23,
                "name": "admin"
            },
            "created_at": 1420145644
        }
    ]

}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/26 李世星 新增
2022/02/11 李世星 修改添加企业id参数(company_id)为多个(company_ids)

移除场次下的指定企业

接口地址

/saas/job_share/company

请求方式

PUT

请求参数

参数 类型 说明 必填
company_ids string 公司id
siteId int 场次ID

请求示例

为指定场次添加企业
curl --location --request PUT '/api/saas/job_share/company' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbMV0sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTYzNTgzOTkxNSwiZXhwIjoxNjM2NDQ0NzE1fQ.MHcaByL7YDkSrgL4ZWGlfwCBz_okE_l9fvaWR_OYEUg' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'company_ids=36' \
--data-urlencode 'siteId=4'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list Object 移除企业列表

list:Object 数据列表

参数 类型 说明
id int 主键id
remove_time int 移除时间

返回示例

{
    "status":0,
    "error": "",
    "data": [
        {
            "id": 35,
            "remove_time": 1421542111
        }
    ]

}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/26 李世星 新增
2022/02/11 李世星 移除企业id为多个(company_id更换为company_ids)

设置企业置顶

接口地址

/saas/job_share/company/{companyId}/is_top

请求方式

PUT

请求参数

RequestBody

参数 类型 说明 必填
is_top int 是否置顶 1为置顶2为取消置顶
siteId int 场次ID

请求示例

为指定场次添加企业
curl --location --request PUT '/api/saas/job_share/company/223/is_top' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbM10sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTY0NTU4Mjg1NSwiZXhwIjoxNjQ2MTg3NjU1fQ.5K2Q6P8-_tUZeKw_O4JeKnf77dSgQcwsXFyuFSUXhxw' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'is_top=2' \
--data-urlencode 'site_id=4'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data Object 企业描述

data:Object 数据列表

参数 类型 说明
id int 企业id
name string 企业名称
state int 企业状态
admin_user Object 操作管理员
created_at int 创建时间

admin_user:Object 操作管理员

参数 类型 说明
id int 管理员id
name string 管理员昵称

返回示例

{
    "status": 0,
    "data": {
        "id": 223,
        "name": "南山集团",
        "state": 1,
        "admin_user": {
          "id": 1,
          "name": "测试账号"
    },
    "created_at": 1645151862
    }
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/02/23 李世星 新增

导出双选会下公司信息

JOB_SHARE_COMPANY_EXPORT_EXCEL

导出双选会下公司信息

GET: /api/saas/job_share/company/excel/16?name=北斗三号全球&top=1

HTTP Method

GET

HTTP Request

/api/saas/job_share/company/excel/{site_id}

Request Parameters Query

Parameter Description Type Required Explain
name 公司名称 string 搜索条件
top 是否置顶 int 1:是, 0:否

Request Parameters Body

Response Data

Log

日期 作者 内容
2022/7/13 李晓东 新增

宣讲会 careerTalk

宣讲会列表

JOB_CAREER_TALK_LIST

获取宣讲会列表

GET: /api/saas/career/talk?name=分析&status=1&year=2021

Response Body:

{
  "status": 0,
  "current_page": 1,
  "last_page": 1,
  "total": 1,
  "per_page": 10,
  "list": [
    {
      "id": 4,
      "name": "分析师大会",
      "year": 2021,
      "start_time": 1638320400,
      "end_time": 1657976400,
      "type": 3,
      "type_name": "口播加演播",
      "unit_id": 113,
      "unit_name": "职场改版-有报名有链接属性",
      "status": true,
      "top_time": false,
      "start_status": 0
    }
  ]
}

HTTP Method

GET

HTTP Request

/api/saas/career/talk

Request Parameters Query

Parameter Description Type Required Explain
page 页码 Number
limit 条数 Number
name 宣讲会名称 string 搜索条件
status 上架状态 Number 0:下架 1:上架
year 宣讲年限 Number 搜索条件
top 是否置顶 Number 1:置顶 0:非置顶

Request Parameters Body

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
current_page 当前页 Number
last_page 下一页 Number
total 总数 Number
per_page 查询条数 Number
list 返回数据 array

List Object

Title Description Type Tips Version
id CareerTalk ID Number
name 宣讲会名称 String
year 空宣年限 Number
start_time 开始时间 Number
end_time 结束时间 Number
type 宣讲类型 Number 1-仅口播 2-仅演播 3-口播+演播
type_name 宣讲类型名称 string
unit_id 模板ID Number 2022 10月份 迭代
unit_name 模板名称 Number 2022 10月份 迭代
status 状态 bool true-上架 false-下架
top_time 是否置顶 bool true-置顶 false-未置顶
start_status 开启状态 Number 0-均未开启 1-开启口播 2-开启直播

Log

日期 作者 内容
2022/7/13 李晓东 新增
2022/9/01 李晓东 增加置顶筛选条件

创建宣讲会信息

JOB_CAREER_TALK_STORE

创建宣讲会信息

POST: /api/saas/career/talk

Response Body:

{
  "status": 0,
  "data": {
    "id": 95,
    "name": "集微龙门阵九期—北斗三号全球服务倒计时:北斗全球化视野下的芯片与产业发展",
    "short_name": "龙门阵",
    "entrance_live_time": 1580519510,
    "start_time": 1580519520,
    "end_time": 1580541120,
    "quit_live_time": 1580519510,
    "live_id": 168,
    "preview": "jiwei\/video\/1657598509389.mp4",
    "preview_cover": "jwImg\/6795309f4ab3f9f0.png",
    "playback": "",
    "playback_cover": "jwImg\/6795309f4ab3f9f0.png",
    "type": 1,
    "unit_id": 121,
    "cover": "jwImg\/6795309f4ab3f9f0.png",
    "intro": "集微网第九期“集微龙门阵”将于2020年5月8日(周五)19点以线上论坛形式召开,主题为“北斗三号全球服务倒计时:北斗全球化视野下的芯片与产业发展”,围绕上述热点话题展开线上探讨交流。",
    "year": "2020",
    "hot_num": 94,
    "created_at": 1661999238,
    "updated_at": 1661999238
  }
}

HTTP Method

POST

HTTP Request

/api/saas/career/talk

Request Parameters Query

Request Parameters Body

Parameter Description Type Required Explain Version
live_id 直播ID Number
cover 封面图 string
name 宣讲会名称 string
short_name 宣讲会简称 string
type 宣讲会类型 Number 1-仅口播 2-仅演播 3-口播+演播
entrance_live_time 进入直播时间 Number
start_time 开始时间 Number
end_time 结束时间 Number
quit_live_time 退出时间 Number
intro 内容简介 string
unit_id 相关模板id Number 2022 10月份 迭代
preview 预告视频 String
playback 回放视频 String
preview_cover 预告视频封面图地址 string
playback_cover 回放视频封面图地址 string
hot_num 热度值 Number

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips Version
id CareerTalk ID Number
name 宣讲会名称 String
short_name 宣讲会名简称 String
entrance_live_time 进入直播时间 Number
start_time 开始时间 Number
end_time 结束时间 Number
quit_live_time 退出直播时间 Number
live_id 直播ID Number
preview 预告视频地址 String
preview_cover 预告视频封面图地址 String
playback 视频回放地址 String
playback_cover 视频回放封面图地址 String
type 宣讲类型 Number 1-仅口播 2-仅演播 3-口播+演播
unit_id 模板ID Number 2022 10月份 迭代
cover 封面图 String
intro 简介 String
year 宣讲年 Number
hot_num 热度值 Number
created_at 创建时间 String
updated_at 更新时间 String

Log

日期 作者 内容
2022/7/13 李晓东 新增
2022/8/13 李晓东 编辑
2022/9/01 李晓东 编辑

编辑宣讲会信息

JOB_CAREER_TALK_EDIT

编辑宣讲会信息

PUT: /api/saas/career/talk/6

Response Body:

{
  "status": 0,
  "data": {
    "id": 95,
    "name": "集微龙门阵九期—北斗三号全球服务倒计时:北斗全球化视野下的芯片与产业发展",
    "short_name": "龙门阵",
    "entrance_live_time": 1580519510,
    "start_time": 1580519520,
    "end_time": 1580541120,
    "quit_live_time": 1580519510,
    "live_id": 168,
    "preview": "jiwei\/video\/1657598509389.mp4",
    "preview_cover": "jwImg\/6795309f4ab3f9f0.png",
    "playback": "",
    "playback_cover": "jwImg\/6795309f4ab3f9f0.png",
    "type": 1,
    "unit_id": 121,
    "cover": "jwImg\/6795309f4ab3f9f0.png",
    "intro": "集微网第九期“集微龙门阵”将于2020年5月8日(周五)19点以线上论坛形式召开,主题为“北斗三号全球服务倒计时:北斗全球化视野下的芯片与产业发展”,围绕上述热点话题展开线上探讨交流。",
    "year": "2020",
    "hot_num": 94,
    "created_at": 1661999238,
    "updated_at": 1661999238
  }
}

HTTP Method

PUT

HTTP Request

/api/saas/career/talk/{id}

Request Parameters Query

Request Parameters Body

Parameter Description Type Required Explain Version
live_id 直播ID Number
cover 封面图 string
name 宣讲会名称 string
short_name 宣讲会简称 string
type 宣讲会类型 Number 1-仅口播 2-仅演播 3-口播+演播
entrance_live_time 进入直播时间 Number
start_time 开始时间 Number
end_time 结束时间 Number
quit_live_time 退出时间 Number
intro 内容简介 string
unit_id 相关模板ID Number 2022 10月份 迭代
preview 预告视频 String
playback 回放视频 String
preview_cover 预告视频封面图地址 string
playback_cover 回放视频封面图地址 string
hot_num 热度值 Number

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips Version
id CareerTalk ID Number
name 宣讲会名称 String
short_name 宣讲会名简称 String
entrance_live_time 进入直播时间 Number
start_time 开始时间 Number
end_time 结束时间 Number
quit_live_time 退出直播时间 Number
live_id 直播ID Number
preview 预告视频地址 String
preview_cover 预告视频封面图地址 String
playback 视频回放地址 String
playback_cover 视频回放封面图地址 String
type 宣讲类型 Number 1-仅口播 2-仅演播 3-口播+演播
unit_id 模板ID Number 2022 10月份 迭代
cover 封面图 String
intro 简介 String
year 宣讲年 Number
hot_num 热度值 Number
created_at 创建时间 String
updated_at 更新时间 String

Log

日期 作者 内容
2022/7/13 李晓东 新增
2022/8/13 李晓东 修改
2022/9/01 李晓东 修改

获取某个宣讲会详情信息

JOB_CAREER_TALK_SHOW

获取某个宣讲会详情信息

GET: /api/saas/career/talk/94

Response Body:

{
  "status": 0,
  "data": {
    "id": 94,
    "name": "YB测试新建宣讲会1661996613",
    "short_name": "烁嗳创宣",
    "entrance_live_time": 1580519510,
    "start_time": 1661996613,
    "end_time": 1662007413,
    "quit_live_time": 1580519510,
    "live_id": 145,
    "preview": "jiwei/video/1657598509389.mp4",
    "preview_cover": "jwImg/6795309f4ab3f9f0.png",
    "playback": "",
    "playback_cover": "jwImg/6795309f4ab3f9f0.png",
    "type": 3,
    "unit_id": 0,
    "cover": "jwImg/6795309f4ab3f9f0.png",
    "intro": "测试新建",
    "year": 2022,
    "hot_num": 91,
    "top_time": false,
    "status": 0,
    "start_status": 0,
    "created_at": 1661996560,
    "updated_at": 1661996613
  }
}

HTTP Method

GET

HTTP Request

/api/saas/career/talk/{id}

Request Parameters Query

Request Parameters Body

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips Version
id CareerTalk ID Number
name 宣讲会名称 String
short_name 宣讲会简称 String
entrance_live_time 进入直播时间 Number
start_time 开始时间 Number
end_time 结束时间 Number
quit_live_time 退出直播时间 Number
live_id 直播ID Number
preview 预告视频地址 String
preview_cover 预告视频封面图地址 String
playback 视频回放地址 String
playback_cover 视频回放封面图地址 String
type 宣讲类型 Number 1-仅口播 2-仅演播 3-口播+演播
unit_id 模板ID Number 2022 10月份 迭代
cover 封面图 String
intro 简介 String
year 宣讲年 Number
hot_num 热度值 Number
top_time 是否置顶 Bool
status 上下架 Number 0-下架 1-上架
start_status 开始状态 Number 0未开启 1开启口播 2开启演播
created_at 创建时间 Number
updated_at 更新时间 Number

Log

日期 作者 内容
2022/7/13 李晓东 新增
2022/8/13 李晓东 修改
2022/9/01 李晓东 修改

删除某个宣讲会信息

JOB_CAREER_TALK_DELETE

获取某个宣讲会详情信息

DELETE: /api/saas/career/talk/3

Response Body:

{
  "status": 0,
  "data": {
    "id": 3,
    "deleted_at": 1657162189
  }
}

HTTP Method

DELETE

HTTP Request

/api/saas/career/talk/{id}

Request Parameters Query

Request Parameters Body

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
id CareerTalk ID Number
deleted_at 删除时间 Number

Log

日期 作者 内容
2022/7/13 李晓东 新增

修改宣讲会状态

JOB_CAREER_TALK_EDIT_STATUS

修改宣讲会状态

PUT: /api/saas/career/talk/6/status

Response Body:

{
  "status": 0,
  "data": {
    "id": 6,
    "status": true
  }
}

HTTP Method

PUT

HTTP Request

/api/saas/career/talk/{id}/status

Request Parameters Query

Request Parameters Body

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
id CareerTalk ID Number
status 上下架 Bool false-下架 true-上架

Log

日期 作者 内容
2022/7/13 李晓东 新增

修改宣讲会置顶状态

JOB_CAREER_TALK_EDIT_TOP_TIME

修改宣讲会状态

PUT: /api/saas/career/talk/3/top

Response Body:

{
  "status": 0,
  "data": {
    "id": 3,
    "top_time": false
  }
}

HTTP Method

PUT

HTTP Request

/api/saas/career/talk/{id}/top

Request Parameters Query

Request Parameters Body

Parameter Description Type Required Explain
is_top 是否置顶 Number 1-连续置顶 0-取消置顶

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
id CareerTalk ID Number
top_time 是否置顶 Bool false-下架 true-上架

Log

日期 作者 内容
2022/7/13 李晓东 新增

修改宣讲会开启状态

JOB_CAREER_TALK_EDIT_START_STATUS

修改宣讲会开启状态

PUT: /api/saas/career/talk/3/start/status

Response Body:

{
  "status": 0,
  "data": {
    "id": 3,
    "start_status": 1,
    "start_status_name": "开始口播"
  }
}

HTTP Method

PUT

HTTP Request

/api/saas/career/talk/{id}/start/status

Request Parameters Query

Request Parameters Body

Parameter Description Type Required Explain
status 开始状态 Number 0-取消开始 1-开始口播 2-开始演播

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
id CareerTalk ID Number
start_status 直播状态 Number 0-取消开始 1-开始口播 2-开始演播
start_status_name 直播状态名称 String

Log

日期 作者 内容
2022/7/13 李晓东 新增

获取宣讲会资源信息

JOB_CAREER_TALK_RESOURCE

获取宣讲会资源信息

GET: /api/saas/career/talk/resource

Response Body:

{
  "status": 0,
  "data": {
    "search": {
      "year": [
        2021,
        2022
      ],
      "status": [
        "未上架",
        "已上架"
      ]
    },
    "store": {
      "type": {
        "1": "仅口播",
        "2": "仅演播",
        "3": "口播加演播"
      }
    }
  }
}

HTTP Method

GET

HTTP Request

/api/saas/career/talk/resource

Request Parameters Query

Request Parameters Body

Response Data

Resource Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
Search 搜索对象 Object
store 创建对象 Object

Search Object

Title Description Type Tips
year 空宣年限 array
status 状态 array

Store Object

Title Description Type Tips
type 空宣类型 array 1: "仅口播", 2: "仅演播", 3: "口播加演播"

Log

日期 作者 内容
2022/7/13 李晓东 新增

获取宣讲会下能够添加的企业列表

JOB_CAREER_TALK_COMPANY_CUSTOMERS

获取宣讲会下能够添加的企业列表

GET: /api/saas/career/talk/3/company/list?type=1

Response Body:

{
  "status": 0,
  "current_page": 1,
  "last_page": 10,
  "total": 99,
  "per_page": 10,
  "list": [
    {
      "id": 170,
      "name": "华夏幸福基业投资部",
      "state": 0,
      "admin_user": {
        "id": null,
        "name": ""
      }
    }
  ]
}

HTTP Method

GET

HTTP Request

/api/saas/career/talk/{career_talk_id}/company/list?type=1&name=华夏&limit=5

Request Parameters Query

Parameter Description Type Required Explain
name 公司名称 string 搜索条件
type 名单类型 Number 1-口播名单 2-演播名单
page 页码 Number
limit 条数 Number

Request Parameters Body

Response Data

Company Object

Title Description Type Tips
status code 0为成功 Number
current_page 当前页 Number
last_page 下一页 Number
total 总数 Number
per_page 查询条数 Number
list 返回数据 array

List Object

Title Description Type Tips
id Company ID Number
name 公司名称 String
state 宣讲会与公司关联状态 Number 1-已关联 0-未关联
admin_user 进行关联操作用户 Object

admin_user Object

Title Description Type Tips
id 用户ID Number
name 用户名称 Array

Log

日期 作者 内容
2022/7/13 李晓东 新增

宣讲会下新增公司信息

JOB_CAREER_TALK_COMPANY_STORE

宣讲会下新增公司信息

POST: /api/saas/career/talk/6/company

Response Body:

{
  "status": 0,
  "list": [
    {
      "id": 170,
      "name": "华夏幸福基业投资部",
      "admin_user": {
        "id": 1,
        "name": "测试账号"
      },
      "created_at": 1657780015
    }
  ]
}

HTTP Method

POST

HTTP Request

/api/saas/career/talk/{career_talk_id}/company

Request Parameters Query

Request Parameters Body

Parameter Description Type Required Explain
company_ids 公司ID String
type 宣讲会名单类型 Number 1-口播名单 2-演播名单

Response Data

Company Result Object

Title Description Type Tips
status code 0为成功 Number
List 返回数据 Array

List Array

Title Description Type Tips
id Company ID Number
name 公司名称 String
state 宣讲会与公司关联状态 Number 1-已关联 0-未关联
admin_user 进行关联操作用户 Object

admin_user Object

Title Description Type Tips
id 用户ID Number
name 用户名称 Array

Log

日期 作者 内容
2022/7/13 李晓东 新增

获取宣讲会下口播/演播公司列表

JOB_CAREER_TALK_COMPANY_LIST

获取宣讲会下口播/演播公司列表

GET: /api/saas/career/talk/6/company?type=2&name=华为

Response Body:

{
  "status": 0,
  "current_page": 1,
  "last_page": 1,
  "total": 1,
  "per_page": 10,
  "list": [
    {
      "id": 13,
      "company_Id": 172,
      "name": "华为科技有限公司",
      "post_num": 0,
      "resume_num": 0,
      "start_time": null,
      "live_time": 0,
      "is_show": false
    }
  ]
}

HTTP Method

GET

HTTP Request

/api/saas/career/talk/{career_talk_id}/company?type=2

Request Parameters Query

Parameter Description Type Required Explain
name 公司名称 string 搜索条件
type 名单类型 Number 1-口播名单 2-演播名单
page 页码 Number
limit 条数 Number

Request Parameters Body

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
current_page 当前页 Number
last_page 下一页 Number
total 总数 Number
per_page 查询条数 Number
list 返回数据 array

List Object

Title Description Type Tips
id 宣讲会与企业关联的ID Number
company_Id 企业ID Number
name 企业名称 String
post_num 岗位数 Number
resume_num 投递简历数 Number
start_time 开始时间 Number
live_time 直播时长 Number
is_show 是否前端展示 bool ture-展示 false-不展示

Log

日期 作者 内容
2022/7/13 李晓东 新增

编辑宣讲会关联公司相关信息

JOB_CAREER_TALK_COMPANY_EDIT

编辑宣讲会关联公司相关信息

PUT: /api/saas/career/talk/3/company/4

Response Body:

{
  "status": 0,
  "data": {
    "id": 4,
    "start_time": 1657933200,
    "live_time": 1,
    "video_name": "",
    "video_url": ""
  }
}

HTTP Method

PUT

HTTP Request

/api/saas/career/talk/{career_talk_id}/company/{id}

Request Parameters Query

Request Parameters Body

Parameter Description Type Required Explain
start_time 开始时间 Number
live_time 直播时长 string
video_name 视频名称 string
video_url 视频地址 string
video_cover 视频封面图 string

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
id 宣讲会与公司关联 ID Number
start_time 开始时间 Number
live_time 直播时长 string
video_name 视频名称 string
video_url 视频地址 string
video_cover 视频封面图 string

Log

日期 作者 内容
2022/7/13 李晓东 新增

获取宣讲会下关联公司信息

JOB_CAREER_TALK_COMPANY_INFO

获取宣讲会下关联公司信息

GET: /api/saas/career/talk/3/company/13

Response Body:

{
  "status": 0,
  "data": {
    "id": 13,
    "start_time": 1657933200,
    "live_time": 1,
    "video_name": "",
    "video_url": "",
    "video_cover": ""
  }
}

HTTP Method

GET

HTTP Request

/api/saas/career/talk/{career_talk_id}/company/{id}

Request Parameters Query

Request Parameters Body

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
id 宣讲会与公司关联 ID Number
start_time 开始时间 Number
live_time 直播时长 string
video_name 视频名称 string
video_url 视频地址 string
video_cover 视频封面图 string

Log

日期 作者 内容
2022/7/13 李晓东 新增

删除绑定关系信息

JOB_CAREER_TALK_COMPANY_DELETE

删除绑定关系信息

DELETE: /api/saas/career/talk/3/company/333

Response Body:

{
  "status": 0,
  "data": {
    "id": 3,
    "deleted_at": 1657162189
  }
}

HTTP Method

DELETE

HTTP Request

/api/saas/career/talk/{career_talk_id}/company/{company_id}

Request Parameters Query

Request Parameters Body

Parameter Description Type Required Explain
type 宣讲会下名单类型 Number 1-口播名单 2-演播名单

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
id CareerTalk ID Number
deleted_at 删除时间 Number

Log

日期 作者 内容
2022/7/13 李晓东 新增

设置公司在前台显示接口

JOB_CAREER_TALK_COMPANY_SHOW

设置公司在前台显示接口

PUT: /api/saas/career/talk/3/company/4/show

Response Body:

{
  "status": 0,
  "data": {
    "id": 4,
    "type": 2,
    "is_show": 0
  }
}

HTTP Method

PUT

HTTP Request

/api/saas/career/talk/{career_talk_id}/company/{id}/show

Request Parameters Query

Request Parameters Body

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
id 宣讲会与企业关联 ID Number
type 宣讲会类型 Number 1-口播 2-演播
is_show 是否显示 Bool true-展示 false-不展示

Log

日期 作者 内容
2022/7/13 李晓东 新增

导出宣讲会下所有公司信息

JOB_CAREER_TALK_COMPANY_EXPORT_EXCEL

导出宣讲会下所有公司信息

GET: /api/saas/career/talk/6/company/excel?name=北斗三号全球&type=2

HTTP Method

GET

HTTP Request

/api/saas/career/talk/{career_talk_id}/company/excel

Request Parameters Query

Parameter Description Type Required Explain
name 公司名称 string 搜索条件
type 名单类型 Number 1-口播, 2-演播

Request Parameters Body

Response Data

Log

日期 作者 内容
2022/7/13 李晓东 新增

数据汇总 report

系统的数据汇总详情接口

系统的数据汇总详情接口

接口地址

/report/summary/job

请求方式

get

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data array 数据列表
新增企业数 客户
新增岗位数 职位
新增用户数 c端用户
新增在线简历数 简历
新增附件简历数 附件简历
参数 类型 说明
total int 总数
yesterday int 昨日新增

返回示例

{
  "status": 0,
  "data": {
    "新增企业数": {
      "total": 11,
      "yesterday": 9
    },
    "新增用户数": {
      "total": 11,
      "yesterday": 9
    },
    "新增岗位数": {
      "total": 8,
      "yesterday": 1
    },
    "新增在线简历数": {
      "total": 4,
      "yesterday": 0
    },
    "新增附件简历数": {
      "total": 4,
      "yesterday": 0
    }
  }
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/27 李世星 修改 新增 c端用户统计数 区分 word_cv 在线简历数 annex_cv 附件简历数

获取指定月每周的数据

获取指定月每周的数据

接口地址

/report/chart/data/months

请求方式

get

请求参数

参数 类型 说明 必填
start_months string 开始查询的月份
end_months string 结束查询的月份
is_export int 是否导出表格 1为导出0或空下发json数据

请求示例

curl --location --request GET '/api/report/chart/data/months?start_months=202111&end_months=202201' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbMV0sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTYzNTgzOTkxNSwiZXhwIjoxNjM2NDQ0NzE1fQ.MHcaByL7YDkSrgL4ZWGlfwCBz_okE_l9fvaWR_OYEUg'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data array 数据列表
参数 类型 说明
weekList string 周列表
dataList object 对应周列表数据

dataList: object 对应周列表数据

参数 类型 说明
新增企业数 string 对应周新增公司数据
新增岗位数 object 对应周新增c端用户数据
新增用户数 object 对应周新增职位数据
新增在线简历数 object 对应周新增在线简历数据
新增附件简历数 object 对应周新增附件简历数据

返回示例

{
  "status": 0,
  "error": "",
  "data": {
    "weekList": [
      "20211101",
      "20211108",
      "20211115",
      "20211122",
      "20211129",
      "20211206",
      "20211213",
      "20211220",
      "20211227",
      "20220103",
      "20220110",
      "20220117"
    ],
    "dataList": {
      "新增企业数": [10,5,7,2,3,10,20,1,2,4,12,5],
      "新增岗位数": [10,5,10,20,7,2,3,1,2,4,12,5],
      "新增用户数": [7,2,3,10,20,1,2,4,10,5,12,5],
      "新增在线简历数": [10,5,0,20,1,27,2,3,1,4,12,5],
      "新增附件简历数": [110,20,1,0,5,7,2,3,2,4,12,5]
    }
  }
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/27 李世星 新增

获取一年内每月的职位发布数

获取客户发布的职位排行榜

接口地址

/report/chart/position

请求方式

get

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data array 数据列表
参数 类型 说明
monthList string 月列表
numList object 列表数据

返回示例

{
  "status": 0,
  "data": {
    "monthList": [
      "5月",
      "6月",
      "7月",
      "8月",
      "9月",
      "10月",
      "11月",
      "12月",
      "1月",
      "2月",
      "3月",
      "4月"
    ],
    "numList": [
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      3,
      3,
      2
    ]
  }
}

Status返回值

获取客户发布的职位排行榜

获取客户发布的职位排行榜

接口地址

/report/rank/customer/position

请求方式

get

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
dat array 客户列表
参数 类型 说明
id int
customer_name string 名名
position_count int 职位数量

返回示例

{
  "status": 0,
  "data": [
    {
      "id": 8,
      "customer_name": "客户名称1",
      "position_count": 5
    },
    {
      "id": 1,
      "customer_name": "马芸",
      "position_count": 2
    },
    {
      "id": 2,
      "customer_name": "马话疼",
      "position_count": 1
    },
    {
      "id": 3,
      "customer_name": "罗泳好",
      "position_count": 0
    },
    {
      "id": 7,
      "customer_name": "客户名称1",
      "position_count": 0
    },
    {
      "id": 9,
      "customer_name": "客户名称2",
      "position_count": 0
    },
    {
      "id": 10,
      "customer_name": "客户名称3",
      "position_count": 0
    },
    {
      "id": 11,
      "customer_name": "客户名称4",
      "position_count": 0
    },
    {
      "id": 12,
      "customer_name": "客户名称4",
      "position_count": 0
    },
    {
      "id": 13,
      "customer_name": "客户名称4",
      "position_count": 0
    }
  ]
}

Status返回值

查看全部服务类型的信息

获取全部的可使用客户服务分类类型

接口地址

/saas/job/config/project/case

请求方式

GET

请求参数

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array 类型(Case)列表

Case:Object类别

参数 类型 说明
id int
name string 名名
label string 注释
code string 识别码

返回示例

{
  "status": 0,
  "data": [
    {
      "id": 1,
      "name": "HR",
      "label": "HR",
      "code": "hr"
    },
    {
      "id": 2,
      "name": "猎头",
      "label": "猎头",
      "code": "hunter"
    }
  ]
}

Status返回值

简历 cv

投递的简历列表、搜索接口

使用这个接口 获取所有简历列表

排序按照创建时间由近及远进行

接口地址

/saas/job/cv/deliver

请求方式

GET

请求参数 body传参

参数 类型 说明(如果一起传多个则会都满足的情况才会返回结果,如果不想搜索某条件,则不传该参数) 必填
page int 第几页
limit int 每页条数
position_id int 职位下投递的简历列表 position_id=1
name string 模糊搜索姓名name='eric'

请求示例

// body 传参示例
{
    "page":2,       // 第二页
    "limit":20,     // 每页20
    "position_id": 1, // 职位id
    "name":"姓名" 
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list object 数据列表

返回示例

{
    "status": 0,
    "list": [
        {
            "id": 简历表主键id,
            "name": "姓名",
            "sex": "性别",
            "age": 年龄,
            "educ": "学历",
            "years_name": "工作年限",
            "wish_list": [
                {
                    "id": 求职意向表主键id,
                    "wish_province": "期望省",
                    "wish_city": "期望市",
                    "wish_salary": 期望薪资,
                    "wish_position_name": "期望职能:软件开发 - 产品经理"
                }
            ]
        }
    ],
    "current_page": 当前页码,
    "last_page": 总页数,
    "per_page": 一页多少条,
    "total": 总条数
}

Status返回值

状态码 原因
201
202

下载简历附件

接口地址

/saas/job/cv/download/{cv_id}

请求方式

GET

请求参数

参数 类型 说明 必填
cv_id int 简历主键id

请求示例

// 下载简历表主键id为1的简历附件
/api/saas/job/cv/download/1

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 数据信息

返回示例

{
    "status":0,
    "data":{

    },
}

Status返回值

状态码 原因
201 未找附件简历
202 获取附件简历失败

导出在线简历

接口地址

/saas/job/cv/word/{id}

请求方式

GET

请求参数

参数 类型 说明 必填
id int 简历主键id
source string 来源,oms后台传oms,emp后台传emp
admin_id int 后台用户id

请求示例

// 导出在线简历
/api/saas/job/cv/word/1?source='oms'&admin_id=2

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 数据信息

返回示例

{
    "status":0,
    "data":{

    },
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

查看单个简历详细信息接口

接口地址

/saas/job/cv/{id}

请求方式

GET

请求参数

参数 类型 说明 必填
id int 简历主键id

请求示例

// 搜索姓名叫eric并且为男性的简历
/api/saas/job/cv/1

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 数据信息

data

参数 类型 说明 版本
id int 简历主键ID 2022 10月份 迭代
name string 名称 2022 10月份 迭代
sex int 性别(1男,2女) 2022 10月份 迭代
age int 年龄 2022 10月份 迭代
tel string 电话联系方式 2022 10月份 迭代
email string 邮箱 2022 10月份 迭代
avatar string 头像 2022 10月份 迭代
intro string 个人优势 2022 10月份 迭代
job_status int 求职状态(默认1离职找工作,2在职暂不考虑,3在职考虑机会) 2022 10月份 迭代
status int 状态(默认1全部不可见,2全部可见,3HR可见,4猎头可见) 2022 10月份 迭代
download_num int 下载数 2022 10月份 迭代
province string 2022 10月份 迭代
city string 2022 10月份 迭代
county string 2022 10月份 迭代
years_name string 工作年限 2022 10月份 迭代
school string 学校 2022 10月份 迭代
major string 专业 2022 10月份 迭代
salary string 目前薪资 2022 10月份 迭代
remark string 其他信息 2022 10月份 迭代
updated_at int 更新时间 2022 10月份 迭代
wish_list array 求职意向 2022 10月份 迭代
project_list array 工作经历 2022 10月份 迭代
project_experiences_list array 工作经历 2022 10月份 迭代
educ_list array 教育经历 2022 10月份 迭代
certificate_list array 其他证书 2022 10月份 迭代
interest string 兴趣特长 2022 10月份 迭代
opus_list array 作品展示 2022 10月份 迭代
skill_list array 专业技能 2022 10月份 迭代

project_list

参数 类型 说明 版本
id int ID 2022 10月份 迭代
start_time int 开始时间 2022 10月份 迭代
end_time int 开始时间 2022 10月份 迭代
company string 公司名称 2022 10月份 迭代
position_name int 职务名称 2022 10月份 迭代
department int 部门 2022 10月份 迭代

project_experiences_list

参数 类型 说明 版本
id int ID 2022 10月份 迭代
start_time int 开始时间 2022 10月份 迭代
end_time int 开始时间 2022 10月份 迭代
role string 角色 2022 10月份 迭代
extra string 项目描述 2022 10月份 迭代
name string 项目名称 2022 10月份 迭代
link string 项目链接 2022 10月份 迭代

certificate_list

参数 类型 说明 版本
id int ID 2022 10月份 迭代
name string 证书名称 2022 10月份 迭代
attachment_content string 证书附件 2022 10月份 迭代

opus_list

参数 类型 说明 版本
id int 作品ID 2022 10月份 迭代
name string 作品名称 2022 10月份 迭代
link string 作品连接 2022 10月份 迭代
intro string 作品描述 2022 10月份 迭代
attach array 附件 2022 10月份 迭代

skill_list

参数 类型 说明 版本
id int 专业技能Id 2022 10月份 迭代
name string 专业技能名称 2022 10月份 迭代
mastery string 熟练度 2022 10月份 迭代

返回示例

{
    "status":0,
    "data":{
            "id": 简历表主键id,
            "name": "eric",
            "sex": 性别(1男,2女),
            "age": 年龄,
            "tel": "手机号",
            "email": "邮箱",
            "avatar": "头像",
            "intro": "自我评价",
            "job_status": 求职状态(默认1离职找工作,2在职暂不考虑,3在职考虑机会,
            "status": 状态(默认1全部不可见,2全部可见,3HR可见,4猎头可见),
            "download_num": 下载数,
            "province": "省",
            "city": "市",
            "county": "区",
            "years_name": 工作年限(0为应届生,单位月),
            "salary": 目前薪资(单位:万/年),
            "remark": "其他信息",
            "updated_at": 修改时间戳,
            "created_at": 创建时间戳,
            "wish_list": [ // 求职意向列表
                {
                    "id": 求职意向表主键id,
                    "wish_province": "期望省",
                    "wish_city": "期望市工作地点",
                    "wish_county": "期望区",
                    "wish_salary": 期望薪资(单位:万/年),
                    "wish_position_name": "期望职位名称",
                    "status": 状态,1正常,0删除,
                    "updated_at": 1583845603,
                    "created_at": 1583769600,
                    "position_list": [ // 期望职能列表
                        {
                            "id": 职能标签主键id,
                            "name": "职能标签名",
                            "overview": "介绍,
                            "status": 启用状态 (1 :启用 0 :废弃),
                            "owner_id": 上传拥有者ID,
                            "field_id": 父极职能分类id,
                            "created_at": 1583856000,
                            "updated_at": 1584673240,
                            "field_info": { // 父极职能分类相关信息
                                "id": 父极职能分类主键id,
                                "name": "职能分类名称",
                                "status": 启用状态 (1 :启用 0 :废弃),
                                "owner_id": 上传拥有者ID,
                                "created_at": 1583856000,
                                "updated_at": 1583909034
                            }
                        }
                    ]
                }
            ],
            "project_list": [ // 工作经验列表
                {
                    "id": 工作经验表主键id,
                    "start_time": 开始时间,
                    "end_time": 结束时间,如果为1则是至今, 
                    "company": "公司名",
                    "position_name": 职位名称,
                    "project": "工作经验",
                    "department": "",
                }
            ],
            "project_experiences_list": [
                {
                    "id": 项目经验ID,
                    "start_time": 项目开始时间,
                    "end_time": 项目结束时间,
                    "role": 担任角色,
                    "extra": 项目描述,
                    "name": 项目名称,
                    "link": 项目链接地址,
                }
            ],
            "educ_list": [
                {
                   "id": 教育经历表主键id,
                    "start_time": 开始时间戳,
                    "end_time": 结束时间戳,
                    "educ": 学历(1大专,2本科,3硕士,4博士,5MBA),
                    "school": "学校",
                    "major": "专业",
                    "full_time": 是否全日制(0否,1是),
                    "status": 状态,1正常,0删除,
                    "updated_at": 1583839721,
                    "created_at": 1583769600
                }
            ],
            "interest": 兴趣特长,
            "opus_list": [
              {
                  "id": 2,
                  "name": "作品名称",
                  "link": "作品展示连接",
                  "intro": "作品展示介绍",
                  "attachment_content": ["附件图片地址"]
              }
            ],
            "skill_list": [
                {
                    "id": 4,
                    "name": "技能名称",
                    "mastery": "熟练"
                }
            ],
            "certificate_list": [
                {
                    "id": 3,
                    "name": "证书名称",
                    "attachment_content": ["附件地址"]
                }
            ]
        }
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

简历列表

使用这个接口 获取所有简历列表

排序按照创建时间由近及远进行,若创建时间相同

接口地址

/saas/job/cv

请求方式

GET

请求参数

参数 类型 说明(如果一起传多个则会都满足的情况才会返回结果,如果不想搜索某条件,则该参数传空,body形式传参) 必填
page int 第几页
name string 模糊搜索姓名
sex int 搜索性别(1男,2女,9不限)
educ_list array 搜索学历(0应届生,1大专,2本科,3硕士,4博士,5MBA),json数组形式[1,2],支持多选
years array 搜索工作年限,1为应届生,2为1~3年,3为3~5年,4为5~10年,5为10年以上,支持多选,json数组形式[1,2]
school string 搜索毕业院校
major string 搜索专业
wish_positions array 搜索期望职能,json数组形式[[2,0],[1,1],[3,0]],支持多选最多选中标签5个, 二维数组中第一个值是分类id(注意:第一个值不能为0,否则抛出异常),第二个值是职能id
wish_city string 搜索期望地点,传 map_code 地图标识码
limit int 每页条数

请求示例

// 搜索姓名叫eric并且为男性的简历
/api/saas/job/cv?name="eric"&sex=1

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list object 数据列表

paginate:Object 分页信息

参数 类型 说明
current_page int 当前页码
first_page_url string 第一页url
last_page int 总页数
last_page_url string 最后一页url
next_page_url string 下一页url
path string 当前页url
per_page int 一页多少条
total int 总条数

返回示例

{
    "status": 0,
    "list": [
        {
            "id": 简历表主键id,
            "name": "姓名",
            "sex": "性别",
            "age": 年龄,
            "educ": "学历",
            "years_name": "工作年限",
            "school": "学校",
            "major": "专业",
            "wish_list": [
                {
                    "id": 求职意向表主键id,
                    "wish_province": "期望省",
                    "wish_city": "期望市",
                    "wish_salary": 期望薪资,
                    "wish_position_name": "期望职能:软件开发 - 产品经理"
                }
            ],
          "created_at": 注册时间,
          "updated_at": 更新时间,
        }
    ],
    "current_page": 当前页码,
    "last_page": 总页数,
    "per_page": 一页多少条,
    "total": 总条数
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/27 李世星 修改 新增 school 学校 major 专业搜索参数及下发

列出导出简历任务列表

接口地址

/api/saas/job/cv/download/task

请求方式

GET

请求示例

curl --location --request GET '/api/saas/job/cv/download/task?state=3&type=1&start_time=1645776005000&end_time=1645776364000&page=1&limit=10' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbM10sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTY0NTU4Mjg1NSwiZXhwIjoxNjQ2MTg3NjU1fQ.5K2Q6P8-_tUZeKw_O4JeKnf77dSgQcwsXFyuFSUXhxw'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list object 数据信息

list:Object

参数 类型 说明
id int 任务id
name string 任务名称
state int 任务状态 1为等待处理2为正在处理3为处理完成4为处理失败
cv_type int 1为在线简历2为附件简历3为招聘报名附件简历
success_time int 任务完成日期
download_url string 文件下载地址
created_at int 任务创建日期

返回示例

{
    "status": 0,
    "current_page": 1,
    "last_page": 1,
    "total": 1,
    "per_page": 10,
    "list": [
        {
            "id": 1,
            "name": "202202231400附件简历下载",
            "state": 1,
            "cv_type": 1,
            "success_time": 1645776550,
            "download_url": "http://s.laoyaoba.com/xxx/xxx.zip",
            "created_at": 1645776450
        }
    ]
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/02/25 李世星 新增

新增批量导出任务

接口地址

/api/saas/job/cv/download/task

请求方式

POST

请求参数

参数 类型 说明 必填
ids string 导出简历 userCV id 不填写就是导出所有
source string 来源,oms后台传oms,emp后台传emp
cv_type string 导出简历类型 1为在线简历2为附件简历3为招聘报名附件简历
admin_id int 后台用户id

请求示例

curl --location --request POST '/api/saas/job/cv/download/task' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbM10sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTY0NTU4Mjg1NSwiZXhwIjoxNjQ2MTg3NjU1fQ.5K2Q6P8-_tUZeKw_O4JeKnf77dSgQcwsXFyuFSUXhxw' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'ids=82,86,20' \
--data-urlencode 'admin_id=1' \
--data-urlencode 'cv_type=1' \
--data-urlencode 'source=pc'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array 导入简历列表

返回示例

{
    "status":0,
    "list":[82,86,20]
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/27 李世星 新增

删除简历任务

接口地址

/api/saas/job/cv/download/task/{id}

请求方式

DELETE

请求示例

curl --location --request DELETE '/api/saas/job/cv/download/task/2' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbM10sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTY0NTU4Mjg1NSwiZXhwIjoxNjQ2MTg3NjU1fQ.5K2Q6P8-_tUZeKw_O4JeKnf77dSgQcwsXFyuFSUXhxw'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 数据信息

data:Object

参数 类型 说明
id int 任务id
name string 任务名称
cv_type int 1为在线简历2为附件简历3为招聘报名附件简历
created_at int 任务创建日期
success_time int 任务完成日期

返回示例

{
    "status":0,
    "data":{
        "id": 2,
        "name": "202202231400附件简历下载",
        "cv_type": 1,
        "created_at": 1645776005,
        "success_time": 1645776350,
    }
}

Status返回值

状态码 原因
201 参数有误
202 数据库错误

Log

日期 作者 内容
2022/01/27 李世星 新增

下载导出简历

接口地址

/api/saas/job/cv/download/task/load/{id}

请求方式

GET

请求示例

curl --location --request GET '/api/saas/job/cv/download/task/load/31' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbM10sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTY0NjE4OTQzNiwiZXhwIjoxNjQ2Nzk0MjM2fQ.UBz7A-vdoNCpz588DwYSodzNPq8KblGPbbmPO01u_cg'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 数据信息

返回示例

{
  "status":0,
  "data":{

  }
}

Status返回值

状态码 原因
201 当前任务状态不可下载
202 下载文件失败

Log

日期 作者 内容
2022/01/27 李世星 新增

批量导出简历信息(表格版)

接口地址

/api/saas/job/cv/excel

请求方式

GET

请求参数

参数 类型 说明 必填
ids string 导出简历 userCV id 不填写就是导出所有
source string 来源,oms后台传oms,emp后台传emp
admin_id int 后台用户id

请求示例

curl --location --request GET 'http://127.0.0.1:8081/api/saas/job/cv/excel' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbM10sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTY0NjgwNzgxNSwiZXhwIjoxNjQ3NDEyNjE1fQ.Cny5jYVoom8w8bGbf5mcmb0RQFzt8sHc1fPVC0xdDNU' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'admin_id=1' \
--data-urlencode 'source=pc'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 数据信息

返回示例

{
  "status":0,
  "data":{

  }
}

Status返回值

状态码 原因
201 当前任务状态不可下载
202 下载文件失败

Log

日期 作者 内容
2022/03/09 李世星 新增

简历的投递记录

使用这个接口 获取某个简历投递的记录列表

接口地址

/saas/job/cv/deliver/{id}

请求方式

GET

请求参数

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list object 数据列表
id 记录ID
company_name 公司名称
position_name 职位名称
income 薪资
type 类型
status 状态
created_at 申请时间

paginate:Object 分页信息

参数 类型 说明
current_page int 当前页码
last_page int 总页数
per_page int 一页多少条
total int 总条数

返回示例

{
  "status": 0,
  "list": [
    {
      "id": 335,
      "company_name": "你这个名怎么这么长",
      "position_name": "测试刷新职位啦!",
      "income": "10-30万/年",
      "type": "校招",
      "status": "已查看",
      "created_at": 1595990675
    }
  ],
  "current_page": 1,
  "last_page": 1,
  "per_page": 20,
  "total": 15
}

Log

日期 作者 内容
2022/01/27 李晓东 新增简历投递记录

c端用户数据 job:user

获取全部的C端的用户

可以使用这个接口获取全部C端的用户的信息

接口地址

/api/saas/job/user

请求方式

GET

请求参数

Query Param

参数 类型 说明 必填 版本
nickname string 微信名称搜索
mobile string 电话搜索
cv_status int 简历情况 0全部 1为在线 2为附件 3 在线+附件 2022 10月份 迭代
rs_time int 注册时间 开始 2022 10月份 迭代
re_time int 注册时间 结束 2022 10月份 迭代
ls_time int 登录时间 开始 2022 10月份 迭代
le_time int 登录时间 结束 2022 10月份 迭代
l_method int 登录渠道 1:android 2:ios 3:web 4:小程序 2022 10月份 迭代
r_method int 注册渠道 1:android 2:ios 3:web 4:小程序 2022 10月份 迭代
r_top string 注册时间 asc 正序排序 desc 倒叙排序 2022 10月份 迭代
l_top string 登录时间 asc 正序排序 desc倒叙排序 2022 10月份 迭代

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
yesterday int 昨日新增
total int 总数
complete int 所有数据的总数
current_page int 当期页面
last_page int 最后一页
list array C端客户(UserJoinJob:Object)对象

UserJoinJob:Object

参数 类型 说明 版本
id int
user_id int 集微用户id
nickname string 微信名
avatar string 头像
mobile string 手机
gender int 1男 2女
r_platform int 注册渠道 1:安卓 2:IOS 3:web 4:小程序 2022 10月 迭代
last_use_date int 上次登录时间
used_platform int 上次登录平台 1:安卓 2:IOS 3:web 4:小程序
cv_status int 简历情况 1为在线 2为附件 3 在线+附件 4 无 2022 10月 迭代
created_time int 注册加入时间

返回示例

{
  "status": 0,
  "current_page": 1,
  "last_page": 3,
  "total": 21,
  "yesterday": 1,
  "data": [
    {
      "id": 1,
      "user_id": 5181329,
      "nickname": "易初",
      "avatar": "http://git.dev.jiweinet.com/uploads/-/system/user/avatar/16/avatar.png?width=40",
      "mobile": "13342277828",
      "gender": 1,
      "r_platform": 1,
      "cv_status": 1,
      "last_use_date": 1603259960,
      "used_platform": 1,
      "created_time": 1603259981
    }
  ]
}

Status返回值

Log

日期 作者 内容
2022/10/19 李世星 修改

C端的用户详情

C端的用户详情

接口地址

/api/saas/job/user/{user_id}

请求方式

GET

请求参数

Query Param

请求示例

返回参数

参数 类型 说明 版本
id int join user ID 2022 10月份 迭代
user_id int user ID 2022 10月份 迭代
nickname string 用户名称 2022 10月份 迭代
wechat_name string 微信昵称 2022 10月份 迭代
cv_info userCvInfoObject 用户简历详情 2022 10月份 迭代

cv_info

参数 类型 说明 版本
id int 简历主键ID 2022 10月份 迭代
name string 名称 2022 10月份 迭代
sex int 性别(1男,2女) 2022 10月份 迭代
age int 年龄 2022 10月份 迭代
tel string 电话联系方式 2022 10月份 迭代
email string 邮箱 2022 10月份 迭代
avatar string 头像 2022 10月份 迭代
intro string 个人优势 2022 10月份 迭代
job_status int 求职状态(默认1离职找工作,2在职暂不考虑,3在职考虑机会) 2022 10月份 迭代
status int 状态(默认1全部不可见,2全部可见,3HR可见,4猎头可见) 2022 10月份 迭代
download_num int 下载数 2022 10月份 迭代
province string 2022 10月份 迭代
city string 2022 10月份 迭代
county string 2022 10月份 迭代
years_name string 工作年限 2022 10月份 迭代
school string 学校 2022 10月份 迭代
major string 专业 2022 10月份 迭代
salary string 目前薪资 2022 10月份 迭代
remark string 其他信息 2022 10月份 迭代
updated_at int 更新时间 2022 10月份 迭代
wish_list array 求职意向 2022 10月份 迭代
project_list array 工作经历 2022 10月份 迭代
project_experiences_list array 工作经历 2022 10月份 迭代
educ_list array 教育经历 2022 10月份 迭代
certificate_list array 其他证书 2022 10月份 迭代
interest string 兴趣特长 2022 10月份 迭代
opus_list array 作品展示 2022 10月份 迭代
skill_list array 专业技能 2022 10月份 迭代

project_list

参数 类型 说明 版本
id int ID 2022 10月份 迭代
start_time int 开始时间 2022 10月份 迭代
end_time int 开始时间 2022 10月份 迭代
company string 公司名称 2022 10月份 迭代
position_name int 职务名称 2022 10月份 迭代
department int 部门 2022 10月份 迭代

project_experiences_list

参数 类型 说明 版本
id int ID 2022 10月份 迭代
start_time int 开始时间 2022 10月份 迭代
end_time int 开始时间 2022 10月份 迭代
role string 角色 2022 10月份 迭代
extra string 项目描述 2022 10月份 迭代
name string 项目名称 2022 10月份 迭代
link string 项目链接 2022 10月份 迭代

certificate_list

参数 类型 说明 版本
id int ID 2022 10月份 迭代
name string 证书名称 2022 10月份 迭代
attachment_content string 证书附件 2022 10月份 迭代

opus_list

参数 类型 说明 版本
id int 作品ID 2022 10月份 迭代
name string 作品名称 2022 10月份 迭代
link string 作品连接 2022 10月份 迭代
intro string 作品描述 2022 10月份 迭代
attach array 附件 2022 10月份 迭代

skill_list

参数 类型 说明 版本
id int 专业技能Id 2022 10月份 迭代
name string 专业技能名称 2022 10月份 迭代
mastery string 熟练度 2022 10月份 迭代

返回示例

{
  "status": 0,
  "data": {
    "id": 51,
    "user_id": 5181412,
    "nickname": "跳动的字符",
    "wechat_name": "跳动的字符",
    "cv_info": {
      "id": 20,
      "name": "熊文强",
      "sex": "女",
      "age": 28,
      "tel": "17612189643",
      "email": "574036497@qq.com",
      "intro": null,
      "job_status": "在职,看看机会",
      "status": 2,
      "province": "北京市",
      "city": "北京市",
      "salary": "0 万/年",
      "educ": "博士",
      "remark": "红米您明敏",
      "years_name": "应届生",
      "school": "上海海事大学",
      "major": "人工智能",
      "wish_list": [
        {
          "id": 22,
          "wish_province": "山西省",
          "wish_city": "阳泉市",
          "wish_salary": " 万/年",
          "wish_position_name": "互联网软件 - php开发",
          "position_list": [
            {
              "id": 6,
              "name": "php开发",
              "field_info": {
                "id": 1,
                "name": "互联网软件"
              }
            }
          ]
        }
      ],
      "educ_list": [
        {
          "id": 20,
          "start_time": 1230739200,
          "end_time": 1577808000,
          "school": "上海海事大学",
          "major": "人工智能",
          "full_time": 1,
          "educ": "硕士"
        },
        {
          "id": 58,
          "start_time": 1512403200,
          "end_time": 1578499200,
          "school": "行吗",
          "major": "明",
          "full_time": 1,
          "educ": "硕士"
        },
        {
          "id": 70,
          "start_time": 1597593600,
          "end_time": 1605542400,
          "school": "情侣阿达西",
          "major": "计算机网络",
          "full_time": 1,
          "educ": "硕士"
        },
        {
          "id": 71,
          "start_time": 1314892800,
          "end_time": 1598976000,
          "school": "明敏",
          "major": "蜜蜜",
          "full_time": 1,
          "educ": "大专"
        }
      ],
      "project_experience_list": [],
      "project_list": [
        {
          "id": 27,
          "start_time": 1420041600,
          "end_time": 1546272000,
          "company": "一名",
          "department": "",
          "position_name": "明敏",
          "project": "可口可乐了了"
        }
      ],
      "skill_list": [],
      "opus_list": [],
      "certificate_list": [],
      "created_at": 1591951241,
      "updated_at": 1666666642
    }
  }
}

Status返回值

Log

日期 作者 内容
2022/10/19 李世星 修改

C端的附件简历列表

C端的附件简历列表

接口地址

/api/saas/job/cv/attachment

请求方式

GET

请求参数

Query Param

参数 类型 必填 说明 版本
page int 分页 页数 默认 1 2022 10月份 迭代
limit int 每页 个数 默认 8 2022 10月份 迭代

请求示例

返回参数

参数 类型 说明 版本
id int join user ID 2022 10月份 迭代
user_id int 相关用户id 2022 10月份 迭代
cv_id int 相关简历ID 2022 10月份 迭代
file_name string 附件简历名称 2022 10月份 迭代
download_url string 下载地址 2022 10月份 迭代
size 文件大小 附件文件大小 2022 10月份 迭代
suffix string 后缀名称 2022 10月份 迭代
active int 是否是默认 2022 10月份 迭代
created_at int 上传时间 2022 10月份 迭代
updated_at int 更新时间 2022 10月份 迭代

返回示例

{
  "status": 0,
  "list": [
    {
      "id": 17,
      "user_id": 5181412,
      "cv_id": 20,
      "file_name": "应豪.doc",
      "download_url": "cv/annex/2020/07/28/15959173557151.doc",
      "download_num": 0,
      "size": 40828,
      "suffix": "doc",
      "active": 1,
      "status": 1,
      "updated_at": "2022-10-24 18:45:59",
      "created_at": "2020-07-28 14:22:35"
    }
  ],
  "current_page": 1,
  "last_page": 1,
  "per_page": 10,
  "total": 1
}

Status返回值

Log

日期 作者 内容
2022/10/19 李世星 修改

C端用户简历投递记录

C端的附件简历列表

接口地址

/api/saas/job/user/{userId}/deliver

请求方式

GET

请求参数

Query Param

参数 类型 必填 说明 版本
page int 分页 页数 默认 1 2022 10月份 迭代
limit int 每页 个数 默认 8 2022 10月份 迭代

请求示例

返回参数

参数 类型 说明 版本
id int join user ID 2022 10月份 迭代
company_name int 投递公司名称 2022 10月份 迭代
position_name int 投递职位名称 2022 10月份 迭代
income string 薪资范围 2022 10月份 迭代
type string 职位类型 2022 10月份 迭代
status string 简历投递状态 2022 10月份 迭代
created_at string 简历投递时间 2022 10月份 迭代

返回示例

{
  "status": 0,
  "list": [
    {
      "id": 1405,
      "company_name": "平头哥",
      "position_name": "芯片架构师",
      "income": "80-120万/年",
      "type": "社招",
      "status": "未查看",
      "created_at": 1600073865
    }
  ],
  "current_page": 1,
  "last_page": 6,
  "per_page": 10,
  "total": 120
}

Status返回值

Log

日期 作者 内容
2022/10/19 李世星 修改

招聘活动相关接口 fair:banner

可以使用这个接口获取招聘活动banner的信息

接口地址

/api/saas/job/fair/banner

请求方式

GET

请求参数

Query Param

参数 类型 说明
status string on & off
search string 搜索名称

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
active int 上架数量
shutdown int 下架数量
complete int 所有数据的总数
total int 当前搜索条件的总数
current_page int 当期页面
last_page int 最后一页
list array Banner(Banner:Object)对象

UserJoinJob:Object

参数 类型 说明
id int
name int 活动名称
author_name string 创建者
sort_number int 排序
hit_count int 点击数量
show_xcx boolean 是否小程序端显示
show_app boolean 是否app端显示
show_web boolean 是否web端显示
third_href string 第三方链接地址
has_other boolean 是否有三方链接
has_unit boolean 是否有链接
has_apply boolean 是否可报名
fair_id int 招聘活动页面ID
status int 0:off 1: on
publish_time int 发布时间

返回示例

{
    "status": 0,
    "current_page": 1,
    "last_page": 1,
    "total": 3,
    "active": 1,
    "shutdown": 2,
    "data": [
        {
            "id": 1,
            "name": "X_W校招大会 有链接有报名",
            "author_name": "测试账号",
            "sort_number": 1,
            "hit_count": 0,
            "show_xcx": true,
            "show_app": false,
            "show_web": true,
            "has_unit": true,
            "has_apply": true,
            "has_other": false,
            "third_href": null,
            "fair_id": 1,
            "status": 1,
            "publish_time": 1603271452
        },
        {
            "id": 2,
            "name": "A社招大会 无链接无报名",
            "author_name": "测试账号",
            "sort_number": 2,
            "hit_count": 0,
            "show_xcx": false,
            "show_app": true,
            "show_web": false,
            "has_unit": false,
            "has_apply": false,
            "has_other": false,
            "third_href": null,
            "fair_id": 0,
            "status": 0,
            "publish_time": 1603271487
        },
        {
            "id": 3,
            "name": "X_A招聘会 有链接无报名",
            "author_name": "测试账号",
            "sort_number": null,
            "hit_count": 0,
            "show_xcx": true,
            "show_app": true,
            "show_web": false,
            "has_unit": false,
            "has_apply": false,
            "has_other": true,
            "third_href": "baidu.com",
            "fair_id": null,
            "status": 0,
            "publish_time": 1603271583
        }
    ]
}




Status返回值

Log

日期 作者 内容
2021/06/30 易初 双选会添加了三方链接所使用的other_href字段和has_other字段

接口地址

api/saas/job/fair/banner

请求方式

POST

请求参数

参数 类型 必填 说明
name stirng BANNER名称
sort_num int 排序 不可重复!!!
fair_id int 模板库中招聘活动模板ID,三方链接可以不使用不传这个参或者传0也可以
third_href stirng 三方链接 若没有不可以传这个选项
app_platform_image stirng APP显示图片 不APP显示这个就没有这一项
xcx_platform_image stirng XCX显示图片 不XCX显示这个就没有这一项
web_platform_image stirng WEB显示图片 不WEB显示这个就没有这一项

请求示例

{
    "name": "改招聘小会2(微信小程序+APP)",
    "sort_num": 7,
    "app_platform_image": "4.jpg",
    "xcx_platform_image": "5.jpg",
    "third_href":"baidu.com"
}


返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object Banner(Banner: Object)对象
参数 类型 说明
id int
name int 活动名称
author_name string 创建者
sort_number int 排序
hit_count int 点击数量
show_xcx boolean 是否小程序端显示
show_app boolean 是否app端显示
show_web boolean 是否web端显示
third_href string 第三方链接地址
has_other boolean 是否有三方链接
has_unit boolean 是否有链接
has_apply boolean 是否可报名
fair_id int 招聘活动页面ID
status int 0:off 1: on
publish_time int 发布时间

返回示例

{
    "status": 0,
    "data": {
        "id": 2,
        "name": "A社招大会 无链接无报名",
        "author_name": "测试账号",
        "sort_number": 2,
        "hit_count": 0,
        "show_xcx": false,
        "show_app": true,
        "show_web": false,
        "has_unit": false,
        "has_apply": false,
        "has_other": true,
        "third_href":"baidu.com",
        "fair_id": null,
        "status": 1,
        "publish_time": 1604289050
    }
}



Status返回值

STATUS 说明
201 模板错误
202 name错误
203 图片错误
204 Db错误

Log

日期 作者 内容
2021/06/30 易初 双选会添加了三方链接所使用的other_href字段和has_other字段,fair_id修改为可以为空

接口地址

api/saas/job/fair/banner/{id}

请求方式

PUT

请求参数

参数 类型 必填 说明
name stirng BANNER名称
sort_num int 排序 不可重复!!!
fair_id int 模板库中招聘活动模板ID
third_href string 第三方链接 这个与fair_id为互斥选项
status int 0下架 1上架
app_platform_image stirng APP显示图片 不APP显示这个就没有这一项 **取消显示 需要传一个空字符串**
xcx_platform_image stirng XCX显示图片 不XCX显示这个就没有这一项 **取消显示 需要传一个空字符串**
web_platform_image stirng WEB显示图片 不WEB显示这个就没有这一项 取消显示 需要传一个空字符串

请求示例

{
    "status":1
}   

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object Banner(Banner: Object)对象
参数 类型 说明
id int
name int 活动名称
author_name string 创建者
sort_number int 排序
hit_count int 点击数量
show_xcx boolean 是否小程序端显示
show_app boolean 是否app端显示
show_web boolean 是否web端显示
third_href string 第三方链接地址
has_other boolean 是否有三方链接
has_unit boolean 是否有链接
has_apply boolean 是否可报名
fair_id int 招聘活动页面ID
status int 0:off 1: on
publish_time int 发布时间

返回示例

{
    "status": 0,
    "data": {
        "id": 2,
        "name": "A社招大会 无链接无报名",
        "author_name": "测试账号",
        "sort_number": 2,
        "hit_count": 0,
        "show_xcx": false,
        "show_app": true,
        "show_web": false,
        "has_unit": false,
        "has_apply": false,
        "has_other": true,
        "third_href": "baidu.com",
        "fair_id": null,
        "status": 1,
        "publish_time": 1604289050
    }
}



Status返回值

STATUS 说明
201 模板错误
203 name错误
204 Db错误
205 banner 错误
206 排序错误
202 状态错误

Log

日期 作者 内容
2021/06/30 易初 双选会添加了三方链接所使用的other_href字段和has_other字段,重新定义请求传入参数fair_idthird_href的定义

接口地址

api/saas/job/fair/banner/{id}/attendee

请求方式

GET

请求参数

Query

参数 类型 说明
search string 微信昵称搜索
code string 报名码搜素

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object Banner(Banner: Object)对象
参数 类型 说明
option array 额外选项名称
attendees array 报名信息
参数 类型 说明
id int
nick_name string 报名昵称
code string 报名码
avatar string 头像
gender int 性别
mobile string 手机
is_attach bool 是否有附件简历
attachContentId int 附件简历相关attachContentId
name string 报名人名称
attachType string 附件类型
options array 额外选项 option

optoin:object

参数 类型 说明
option_name string 额外选项名称
content string 选项内容

返回示例

{
    "status": 0,
    "current_page": 1,
    "last_page": 1,
    "total": 1,
    "data": {
        "option": [
            "姓名",
            "性别"
        ],
        "attendees": [
            {
                "id": 1,
                "code": "ABCD12",
                "nick_name": "易初",
                "avatar": "http://git.dev.jiweinet.com/uploads/-/system/user/avatar/16/avatar.png?width=40",
                "gender": 1,
                "mobile": "13342277828",
                "options": [
                    {
                        "option_name": "姓名",
                        "content": "嘻嘻嘻"
                    },
                    {
                        "option_name": "性别",
                        "content": "女"
                    }
                ],
                "is_attach": true,
                "attachContentId": 2334,
                "name": "嘻嘻嘻",
                "attachType": "pdf"
            }
        ]
    }
}




Status返回值

STATUS 说明

接口地址

api/saas/job/fair/banner/{id}

请求方式

GET

请求参数

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object Banner(Banner: Object)对象
参数 类型 说明
id int
name int 活动名称
author_name string 创建者
sort_number int 排序
hit_count int 点击数量
show_xcx boolean 是否小程序端显示
show_app boolean 是否app端显示
show_web boolean 是否web端显示
third_href string 第三方链接地址
has_other boolean 是否有三方链接
has_unit boolean 是否有链接
has_apply boolean 是否可报名
fair_id int 招聘活动页面ID
status int 0:off 1: on
publish_time int 发布时间

返回示例

{
    "status": 0,
    "data": {
        "id": 2,
        "name": "A社招大会 无链接无报名",
        "author_name": "测试账号",
        "sort_number": 2,
        "hit_count": 0,
        "show_xcx": false,
        "show_app": true,
        "show_web": false,
        "xcx_image": "3.jpg",
        "app_image": "2.jpg",
        "web_image": null,
        "has_unit": true,
        "has_apply": false,
        "has_other": false,
        "third_href": null,
        "fair_id": 1,
        "status": 1,
        "publish_time": 1604289050
    }
}



Status返回值

STATUS 说明
201 模板错误
202 name错误
203 图片错误
204 Db错误

接口地址

api/saas/job/fair/resource

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data array 对象
参数 类型 说明
id int
fair_with_apply array 有拥有报名功能 的招聘 Fair:object
fair_without_apply array 没有拥有报名功能 的招聘 Fair:object
order_list array 不可用的排序号

Fair:object

参数 类型 说明
id int
name string 模板页名称

返回示例

{
    "status": 0,
    "data": {
        "fair_with_apply": [
            {
                "id": 12,
                "name": "有报名1",
                "has_apply": true
            }
        ],
        "fair_without_apply": [
            {
                "id": 13,
                "name": "没有报名",
                "has_apply": false
            }
        ],
        "order_list": [
            3,
            2,
            1,
            5,
            8
        ]
    }
}





Status返回值

Log

日期 作者 内容
2021/06/30 易初 双选会添加了三方链接所使用的other_href字段和has_other字段

导出招聘报名人的附件简历

接口地址

/api/saas/job/fair/banner/download/{id}

请求方式

GET

请求参数

参数 类型 说明 必填
id int 报名optionId

请求示例

导出招聘报名人的附件简历
curl --location --request GET '/api/saas/job/fair/banner/download/2334' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6Im9tcyJ9.eyJyb2xlIjpbM10sIm5pY2tuYW1lIjoiXHU2ZDRiXHU4YmQ1XHU4ZDI2XHU1M2Y3IiwiaWQiOiJNUT09IiwiaXNzIjoiT01TQmFzZSIsInN1YiI6Ik9NU0FwaUFjY2VzcyIsImlhdCI6MTY0NTU4Mjg1NSwiZXhwIjoxNjQ2MTg3NjU1fQ.5K2Q6P8-_tUZeKw_O4JeKnf77dSgQcwsXFyuFSUXhxw'

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object 数据信息

返回示例

{
    "status":0,
    "data":{

    },
}

Status返回值

状态码 原因
201 未找附件简历
202 获取附件简历失败

Log

日期 作者 内容
2022/02/28 李世星 新增

招聘报名 fair:apply

修改招聘报名页的属性

接口地址

/api/saas/job/fair/apply/{id}

请求方式

PUT

请求参数

参数 类型 必填 说明
name sting 活动名称
options_list array Option(Option:Object)对象 不可重复!!! 修改的时候传空数组 会清空选项 所以 不修改选项的时候不要传这个key

Option:Object

参数 类型 说明
option_id int Option id
option_tips string 输入提示

请求示例

{
    "name": "中关村招聘会报名!!",
    "options_list": [
        {
            "option_id": 6,
            "option_tips": "哈哈哈"
        },
         {
            "option_id": 4,
            "option_tips": "测试"
        },
         {
            "option_id": 3,
            "option_tips": "哦哦看"
        }
    ]
}


返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object ApplyPage(ApplyPage:Object)对象

ApplyPage:Object

参数 类型 说明
id int
name int 活动名称
active_status bool 状态

返回示例

{
    "status": 0,
    "data": {
        "id": 2,
        "name": "中关村招聘会报名!!",
        "active_status": false
    }
}

Status返回值

STATUS 说明
201 option_list格式问题
202 name重复
203 数据库插入失败

获取招聘报名页中使用的表单选项列表

接口地址

/api/saas/job/fair/option

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array Option(Option:Object)对象

Option:Object

参数 类型 说明
id int
title string 标题

返回示例

{
    "status": 0,
    "data": [
        {
            "id": 1,
            "title": "姓名"
        },
        {
            "id": 2,
            "title": "性别"
        },
        {
            "id": 3,
            "title": "出生年月日"
        },
        {
            "id": 4,
            "title": "学历"
        },
        {
            "id": 5,
            "title": "期望职位能"
        },
        {
            "id": 6,
            "title": "期望地点"
        },
        {
            "id": 7,
            "title": "联系电话"
        },
        {
            "id": 8,
            "title": "期望薪水"
        },
        {
            "id": 9,
            "title": "学校"
        },
        {
            "id": 10,
            "title": "专业"
        }
    ]
}

Status返回值

添加新的招聘报名页

可以使用这个接口新建一个招聘报名页

接口地址

/api/saas/job/fair/apply

请求方式

POST

请求参数

参数 类型 说明
name int 活动名称
options_list array Option(Option:Object)对象 不可重复!!!

Option:Object

参数 类型 说明
option_id int Option id
option_tips string 输入提示

请求示例

{
    "name": "中关村招聘会报名!!",
    "options_list": [
        {
            "option_id": 6,
            "option_tips": "哈哈哈"
        },
         {
            "option_id": 4,
            "option_tips": "测试"
        },
         {
            "option_id": 3,
            "option_tips": "哦哦看"
        }
    ]
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object ApplyPage(ApplyPage:Object)对象

ApplyPage:Object

参数 类型 说明
id int
name int 活动名称
active_status bool 状态

返回示例

{
    "status": 0,
    "data": {
        "id": 2,
        "name": "中关村招聘会报名!!",
        "active_status": false
    }
}

Status返回值

STATUS 说明
201 option_list格式问题
202 name重复
203 数据库插入失败

获取招聘报名页列表

可以使用这个接口获取招聘报名页r的信息

接口地址

/api/saas/job/fair/apply

请求方式

GET

请求参数

Query Param

参数 类型 说明
status string on & off
search string 搜索名称

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
total int 当前搜索条件的总数
current_page int 当期页面
last_page int 最后一页
list array Banner(ApplyPage:Object)对象

ApplyPage:Object

参数 类型 说明
id int
name int 活动名称
author_name string 创建者
status int 0:off 1: on
created_time int 发布时间

返回示例

{
    "status": 0,
    "current_page": 1,
    "last_page": 1,
    "total": 2,
    "data": [
        {
            "id": 1,
            "name": "测试报名页",
            "author_name": "测试账号",
            "status": 1,
            "created_time": 1603683435
        },
        {
            "id": 2,
            "name": "中关村招聘会报名!!",
            "author_name": "测试账号",
            "status": 0,
            "created_time": 1603697536
        }
    ]
}

Status返回值

获取招聘报名页列表

可以使用这个接口获取招聘报名页的信息

接口地址

/api/saas/job/fair/apply/{id}

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object ApplyPage(ApplyPage:Object)对象

ApplyPage:Object

参数 类型 说明
id int
name int 活动名称
list array Option(Option:Object)对象

Option:Object

参数 类型 说明
id int Option id
label string 输入选项的label
input_tips string 输入提示
sort_num int 排序

返回示例

{
    "status": 0,
    "data": {
        "id": 2,
        "name": "中关村招聘会报名!!",
        "options": [
            {
                "id": 6,
                "label": "期望地点",
                "input_tips": "哈哈哈",
                "sort_num": 1
            },
            {
                "id": 4,
                "label": "学历",
                "input_tips": "测试",
                "sort_num": 2
            },
            {
                "id": 3,
                "label": "出生年月日",
                "input_tips": "哦哦看",
                "sort_num": 3
            }
        ]
    }
}

Status返回值

招聘模板 fair:template

修改招聘模板页属性

接口地址

/api/saas/job/fair/template/page/{id}

请求方式

PUT

请求参数

参数 类型 说明
name stirng 活动名称
template_detail array Option(Option:Object)对象 不可重复!!!必须准守新修改的模板所拥有的模块内容来填充,否则不可以创建 修改时只要有template_id就必须全部填充
template_id int 模板库中模板ID 这个和template_detail必须同时存在
apply_page_id int 报名页面ID 如果不修改就不填! 修改不使用报名的模板的时候 这个要填0!

Option:Object

参数 类型 说明
module_id int 模块ID
variable string 模板变量的内容

请求示例


{
    "name": "没有报名",
    "template_id": 1,
    "template_detail": [
       {
              "module_id": 1,
            "variable": "招聘大会"
        },
        {
            "module_id": 3,
            "variable": "这次招聘会的文案这是。"
        }
    ],
    "apply_page_id":0
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object Fair(Fair:Object)对象

Fair:Object

参数 类型 说明
id int
name string 活动名称
template TemplatePage:Object
apply_page ApplyPage:Object

TemplatePage:Object

参数 类型 说明
id int
name int 模板名称

ApplyPage:Object

参数 类型 说明
id int
name int 活动名称

返回示例

{
    "status": 0,
    "data": {
        "id": 12,
        "name": "没有报名",
        "template": {
            "id": 1,
            "name": "标题+文案"
        },
        "apply_page": null
    }
}

Status返回值

STATUS 说明
201 模板错误
202 报名页错误
203 name错误
204 Db错误

新增招聘活动页中使用的模板和报名页选项列表

接口地址

/api/saas/job/fair/template/resource

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array Option(Option:Object)对象

Template:Object

参数 类型 说明
id int
name string 模板名称
has_apply bool 是否拥有报名功能

ApplyPage:Object

参数 类型 说明
id int
name string 报名页名称

Modules:object

参数 类型 说明
id int
name int 活动名称
type int 1 input 2 select 3 date 4 text 5 image 0 其他 输入框类型
tips string 文本框输入提示
limit int 文本框输入限制 0 为没有限制
sort_num int 显示排序

返回示例

{
    "status": 0,
    "data": {
        "template": [
            {
                "id": 1,
                "name": "标题+文本",
                "has_apply": false,
                "modules": [
                    {
                        "id": 1,
                        "name": "标题",
                        "tips": "清啊输入标题,不超过20字",
                        "type": 1,
                        "limit": 20,
                        "sort_num": 1
                    },
                    {
                        "id": 3,
                        "name": "文案",
                        "tips": "随便写点",
                        "type": 4,
                        "limit": 0,
                        "sort_num": 2
                    }
                ]
            },
            {
                "id": 2,
                "name": "标题+图+文案+时间+报名按钮",
                "has_apply": true,
                "modules": [
                    {
                        "id": 1,
                        "name": "标题",
                        "tips": "清啊输入标题,不超过20字",
                        "type": 1,
                        "limit": 20,
                        "sort_num": 1
                    },
                    {
                        "id": 2,
                        "name": "图",
                        "tips": null,
                        "type": 5,
                        "limit": 0,
                        "sort_num": 2
                    },
                    {
                        "id": 3,
                        "name": "文案",
                        "tips": "随便写点",
                        "type": 4,
                        "limit": 0,
                        "sort_num": 3
                    },
                    {
                        "id": 4,
                        "name": "时间",
                        "tips": null,
                        "type": 3,
                        "limit": 0,
                        "sort_num": 4
                    },
                    {
                        "id": 5,
                        "name": "报名按钮",
                        "tips": null,
                        "type": 0,
                        "limit": 0,
                        "sort_num": 5
                    }
                ]
            }
        ],
        "apply_page": [
            {
                "id": 4,
                "name": "新建报名页"
            }
        ]
    }
}

Status返回值

添加新的招聘模板页

接口地址

/api/saas/job/fair/template/page/

请求方式

POST

请求参数

参数 类型 说明
name stirng 活动名称
template_detail array Option(Option:Object)对象 不可重复!!!必须准守这个模板所拥有的模块内容来填充,否则不可以创建
template_id int 模板库中模板ID
apply_page_id int 报名页面ID 模板没有报名功能这个就不填

Option:Object

参数 类型 说明
module_id int 模块ID
variable string 模板变量的内容

请求示例


{
    "name": "没有报名",
    "template_id": 2,
    "template_detail": [
 {
            "module_id": 1,
            "variable": "招聘大会"
        },
        {
            "module_id": 2,
            "variable": "1.jpg"
        },
        {
            "module_id": 3,
            "variable": "这次招聘会的文案这是。"
        },
        {
            "module_id": 4,
            "variable": "2020-10-21 2020-10-25"
        }
    ],
    "apply_page_id":5
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object Fair(Fair:Object)对象

Fair:Object

参数 类型 说明
id int
name string 活动名称
template TemplatePage:Object
apply_page ApplyPage:Object

TemplatePage:Object

参数 类型 说明
id int
name int 模板名称

ApplyPage:Object

参数 类型 说明
id int
name int 活动名称

返回示例

{
    "status": 0,
    "data": {
        "id": 12,
        "name": "没有报名",
        "template": {
            "id": 2,
            "name": "标题+图+文案+时间+报名按钮"
        },
        "apply_page": {
            "id": 5,
            "name": "替身攻击"
        }
    }
}

Status返回值

STATUS 说明
201 模板错误
202 报名页错误
203 name重复
204 Db错误

获取招聘模板页列表

接口地址

/api/saas/job/fair/template/page

请求方式

GET

请求参数

Query Param

参数 类型 说明
status string on & off
search string 搜索名称

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
total int 当前搜索条件的总数
current_page int 当期页面
last_page int 最后一页
list array Fair(Fair:Object)对象

Fair:Object

参数 类型 说明
id int
name int 模板名称
author_name string 创建者
status int 0:off 1: on
created_time int 发布时间

返回示例

{
    "status": 0,
    "current_page": 1,
    "last_page": 1,
    "total": 4,
    "data": [
        {
            "id": 1,
            "name": "测试招聘页面1号",
            "author_name": "测试账号",
            "created_time": 1603439066,
            "status": 1
        },
        {
            "id": 11,
            "name": "测试使用前快滚",
            "author_name": "测试账号",
            "created_time": 1603790240,
            "status": 0
        },
        {
            "id": 12,
            "name": "没有报名",
            "author_name": "测试账号",
            "created_time": 1603853143,
            "status": 0
        },
        {
            "id": 13,
            "name": "没有报名",
            "author_name": "测试账号",
            "created_time": 1603855715,
            "status": 0
        }
    ]
}

Status返回值

获取招聘模板页属性

接口地址

/api/saas/job/fair/template/page/{id}

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
data object Fair(Fair:Object)对象

Fair:Object

参数 类型 说明
id int
name string 活动名称
template TemplatePage:Object
apply_page ApplyPage:Object
modules array Modules:object

TemplatePage:Object

参数 类型 说明
id int
name int 模板名称

ApplyPage:Object

参数 类型 说明
id int
name int 活动名称

Modules:object

参数 类型 说明
id int
name int 活动名称
type int 1 input 2 select 3 date 4 text 5 image 0 其他 输入框类型
tips string 文本框输入提示
limit int 文本框输入限制 0 为没有限制
content string 需文本框中内容 模块的变量内容

返回示例

{
    "status": 0,
    "data": {
        "id": 12,
        "name": "没有报名",
        "template": {
            "id": 2,
            "name": "标题+图+文案+时间+报名按钮"
        },
        "apply_page": {
            "id": 5,
            "name": "替身攻击"
        },
        "modules": [
            {
                "id": 1,
                "name": "标题",
                "type": 1,
                "tips": "清啊输入标题,不超过20字",
                "limit": 20,
                "content": "招聘大会"
            },
            {
                "id": 2,
                "name": "图",
                "type": 5,
                "tips": null,
                "limit": 0,
                "content": "1.jpg"
            },
            {
                "id": 3,
                "name": "文案",
                "type": 4,
                "tips": "随便写点",
                "limit": 0,
                "content": "这次招聘会的文案这是。"
            },
            {
                "id": 4,
                "name": "时间",
                "type": 3,
                "tips": null,
                "limit": 0,
                "content": "2020-10-21 2020-10-25"
            },
            {
                "id": 5,
                "name": "报名按钮",
                "type": 0,
                "tips": null,
                "limit": 0,
                "content": null
            }
        ]
    }
}

Status返回值

图库 gallery

图库所使用的图片类型列表

GALLERY_CATEGORY_LIST

获取图库所使用的图片类型数据

GET: /api/gallery/category

{
    "status": 0,
    "data": [
        {
            "id": 1,
            "name": "专栏图"
        },
        {
            "id": 2,
            "name": "概念图"
        },
        {
            "id": 3,
            "name": "LOGO"
        },
        {
            "id": 4,
            "name": "企业图"
        },
        {
            "id": 5,
            "name": "人物图"
        },
        {
            "id": 6,
            "name": "产品图"
        }
    ]
}

HTTP Method

GET

HTTP Request

/gallery/category

Request Parameters Query

Request Parameters Body

Response Data

Category Object

Title Description Type Tips
id Category ID Int
name 分类名称 String

Log

日期 作者 内容
2021/03/09 易初 新增

图库所使用的图片标签列表

GALLERY_TAG_LIST

获取图库所使用的图片标签数据

GET: /api/gallery/tags

{
    "status": 0,
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "name": "电子"
        },
        {
            "id": 2,
            "name": "半导体"
        },
        {
            "id": 3,
            "name": "华为"
        },
        {
            "id": 4,
            "name": "海思"
        },
        {
            "id": 5,
            "name": "新闻"
        }
    ]
}

HTTP Method

GET

HTTP Request

/gallery/tags

Request Parameters Query

Parameter Description Type Required Explain
search 搜索TAG名称 String 用于搜索是否有相似标签

Request Parameters Body

Response Data

Tag Object

Title Description Type Tips
id Tag ID Int
name 标签名称 String

Log

日期 作者 内容
2021/03/09 易初 新增

新增图库所使用的图片TAG

GALLERY_TAG_NEW

新增一条图片TAG

POST: /api/gallery/tags

{
    "status": 0,
    "data": {
        "id": 9,
        "name": "事实"
    }
}

HTTP Method

POST

HTTP Request

/gallery/tags

Request Parameters Query

Request Parameters Body

Parameter Description Type Required Explain
name TAG名 String 不可以重复

Response Data

Title Description Type Tips
id Tag ID Int
name 标签名称 String

Error

Code Message Description
202 this Pic's tag has used 名字重复

Log

日期 作者 内容
2021/03/09 易初 新增

获取图库中的图片列表

GALLERY_PICTURE_LIST

搜索所有标题为第的分类是专题图片的封面图的最近使用的前三条

GET: /api/gallery?search=第&cover=1&category=3&limit=4&order=1

{
    "status": 0,
    "current_page": 1,
    "last_page": 1,
    "total": 2,
    "data": [
        {
            "id": 6,
            "title": "第7张",
            "tags": [
                {
                    "id": 2,
                    "tag_name": "半导体"
                },
                {
                    "id": 4,
                    "tag_name": "海思"
                }
            ],
            "category": {
                "id": 3,
                "category_name": "LOGO"
            },
            "height": 100,
            "width": 200,
            "size": 1232,
            "src": "http://s.laoyaoba.com/jwImg/newsCover/2021/03/05/16149423855586.jpg",
            "format": "jpeg",
            "used_count": 0,
            "is_cover": 1,
            "copyright": 0,
            "deleteable": 1,
            "last_use": 0,
            "created_time": 1615270589
        },
        {
            "id": 7,
            "title": "第8张",
            "tags": [
                {
                    "id": 3,
                    "tag_name": "华为"
                }
            ],
            "category": {
                "id": 3,
                "category_name": "LOGO"
            },
            "height": 100,
            "width": 200,
            "size": 1232,
            "src": "http://s.laoyaoba.com/jwImg/newsCover/2021/03/05/16149423855586.jpg",
            "format": "jpeg",
            "used_count": 0,
            "is_cover": 1,
            "copyright": 0,
            "deleteable": 1,
            "last_use": 0,
            "created_time": 1615270651
        }
    ]
}

HTTP Method

GET

HTTP Request

/gallery

Request Parameters Query

Parameter Description Required Explain
search 名称搜索 模糊搜索
cover 是否是封面图
category Category ID
tag TAG ID string 1,2,3,4,5 这样拼接ID
order 按最近使用排序 默认按时间倒序
limit 每页个数 默认10

Request Parameters Body

Response Data

Title Description
current_page 当前页面页码
last_page 最后一页页码
total 该资源的全部数量

Picture Object

Title Description Type Tips
id Pic ID Int
title 图片标题 String
tags 图片标签 Array
category 图片分类 Object
height 高度 Int 像素
width 宽度 Int 像素
size 大小 Int byte
src 标题 String
format 格式类型 String
used_count 使用次数 Int
is_cover 是否是封面图 Int
copyright 是否有版权 Int
deleteable 是否可以删除 Int 可以删除显示删除按钮
last_use 最后使用时间 Int
created_time 创建时间 Int

Tag

Title Description Type Tips
id Tag ID Int
name 标签名 String

Category

Title Description Type Tips
id Category ID Int
name 分类名 String

Error

Log

日期 作者 内容
2021/03/09 易初 新增

向图库插入一条新的图片信息

GALLERY_PICTURE_NEW

新增一条图片信息

POST: /api/gallery Body : json { "title": "高清大图2", "category": 3, "tags": "1,5", "height": 100, "width": 200, "size": 1232, "format": "gif", "src": "jwl/12313.gif", "is_cover": 1, "copyright": 0, "deleteable": 1 }

{
    "status": 0,
    "data": {
        "id": 18,
        "title": "高清大图2",
        "tags": [
            {
                "id": 1,
                "tag_name": "电子"
            },
            {
                "id": 5,
                "tag_name": "新闻"
            }
        ],
        "category": {
            "id": 3,
            "category_name": "LOGO"
        }
    }
}

HTTP Method

POST

HTTP Request

/gallery

Request Parameters Query

Request Parameters Body

Parameter Description Type Required Explain
title 图片标题 String 必填
tags 图片标签 string 必填 1,3,4
category 图片分类 int 必填 category id
height 高度 Int 必填 像素
width 宽度 Int 必填 像素
size 大小 Int 必填 byte
src 标题 String 必填
format 格式类型 String 必填
is_cover 是否是封面图 Int 必填
copyright 是否有版权 Int 必填
deleteable 是否可以删除 Int 必填 可以删除显示删除按钮

Response Data

Title Description Type Tips
id Pic ID Int
title 图片标题 String
tags 图片标签 Array
category 图片分类 Object

Tag

Title Description Type Tips
id Tag ID Int
name 标签名 String

Category

Title Description Type Tips
id Category ID Int
name 分类名 String

Error

Code Message Description
203 Insert failed: 插入失败

Log

日期 作者 内容
2021/03/10 易初 新增

向图库上传一张匿名图片

GALLERY_PICTURE_UPLOAD

上传一张图片

POST: /api/gallery/upload?is_cover=1&copyright=1&category=2

{
    "status": 0,
    "data": {
        "id": 19,
        "title": "匿名图片_c7aded27d3a378f147a0dc552065ced2",
        "category": {
            "id": 2,
            "category_name": "概念图"
        },
        "height": 2304,
        "width": 3686,
        "size": 764719,
        "src": "http://s.laoyaoba.com/jwImg/129c5c0e434a6092.jpg",
        "is_cover": "1",
        "copyright": "1",
        "deleteable": 1,
        "last_use": 0,
        "created_time": 1615360017
    }
}

HTTP Method

POST

HTTP Request

/gallery/upload

Request Parameters Query

Parameter Description Type Required Explain
category 图片分类 int category id
is_cover 是否是封面图 Int
copyright 是否有版权 Int 不传为默认图片类型

Request Parameters Body

Response Data

Title Description Type Tips
id Pic ID Int
title 图片标题 String
category 图片分类 Object
height 高度 Int 像素
width 宽度 Int 像素
size 大小 Int byte
src 标题 String
format 格式类型 String
used_count 使用次数 Int
is_cover 是否是封面图 Int
copyright 是否有版权 Int
deleteable 是否可以删除 Int 可以删除显示删除按钮
last_use 最后使用时间 Int
created_time 创建时间 Int

Category

Title Description Type Tips
id Category ID Int
name 分类名 String

Error

Code Message Description
201 Please check Upload Image ! 图片问题
202 Please check Upload Image ! It's so large 图片过大
203 上传失败

Log

日期 作者 内容
2021/03/10 易初 新增

删除图片

GALLERY_PICTURE_DELETE

删除图片

DELETE: /api/gallery/10

{
    "status": 0
}

HTTP Method

DELETE

HTTP Request

/gallery/{id}

Request Parameters Query

Request Parameters Body

Response Data

Error

Log

日期 作者 内容
2021/03/10 易初 新增

礼品 gift

礼品所使用的分类列表

GIFT_CLASS_LIST

礼品所使用的分类列表数据

GET: /api/gift/classify

{
  "status": 0,
  "data": [
    {
      "id": 1,
      "class_name": "INS",
      "is_fast": 1
    }
  ]
}

HTTP Method

GET

HTTP Request

/gift/classify

Request Parameters Query

Request Parameters Body

Response Data

Category Object

Title Description Type Tips
id Category ID Int
name 分类名称 String
is_fast 是否首页和快速匹配 2-否 1-是 int

Log

日期 作者 内容
2021/03/29 张宏伟 新增

获取礼品分类详情信息

GIFT_CLASSIFY_INFO

获取礼品分类详情信息

GET: /api/gift/classify/12

{
  "status": 0,
  "data": {
    "id": 12,
    "class_name": "礼品类",
    "is_show": 1,
    "is_fast": 1,
    "gift_pic": {
      "id": 17,
      "pic_url": "https://t7.baidu.com/it/u=1635608122,693552335&fm=193&f=GIF"
    }
  }
}

HTTP Method

GET

HTTP Request

/gift/classify/{id}

Request Parameters Query

Request Parameters Body

Response Data

Category Object

Title Description Type Tips
id Category ID Int
class_name 分类名 Int
is_show 是否展示 2-不展示 1-展示 3-软删除 Int
is_fast 是否首页和快速匹配 2-否 1-是 Int
gift_pic 分类图片 暂时只有首页分类有 id url array

Log

日期 作者 内容
2021/04/12 张宏伟 新增

新增分类

GIFT_CLASS_NEW

新增一个分类

POST: /api/gift/classify

{
  "status": 0,
  "data": {
    "id": 4,
    "class_name": "小清新"
  }
}

HTTP Method

POST

HTTP Request

/gift/classify

Request Parameters Query

Request Parameters Body

Parameter Description Type Required Explain
class_name 分类名 String 不可以重复
is_show 是否展示 2-不展示 1-展示 int
is_fast 是否首页分类和快速匹配 2-否 1-是 int
gift_pic_url 分类背景图片 选传 如果是首页分类就传 String

Response Data

Title Description Type Tips
id Tag ID Int
class_name 分类名称 String

Error

Code Message Description
201 this gift's class has used 名字重复

Log

日期 作者 内容
2021/03/29 张宏伟 新增

删除礼品

GIFT_DELETE

删除礼品

DELETE: /api/gift/1

{
  "status": 0
}

HTTP Method

DELETE

HTTP Request

/gift/{id}

Request Parameters Query

Request Parameters Body

Response Data

Error

Code Message Description
201 GIFT ID format error id问题
202 GIFT error 删除失败

Log

日期 作者 内容
2021/03/29 张宏伟 新增

删除礼品分类

GIFT_CLASSIFY_DELETE

删除礼品分类

DELETE: gift/classify/12

{
  "status": 0
}

HTTP Method

DELETE

HTTP Request

gift/classify/12

Request Parameters Query

Request Parameters Body

Response Data

Error

Code Message Description
201 GIFT ID format error id问题
202 GIFT error 删除失败

Log

日期 作者 内容
2021/04/09 张宏伟 新增

修改礼品分类信息

GIFT_CLASSIFY_UPD

上传修改礼品分类信息

PUT: /api/gift/classify/12

{
  "class_name": "礼品类",
  "gift_pic_url": "https://t7.baidu.com/it/u=1819248061,230866778&fm=193&f=GIF",
  "is_show": 1,
  "is_fast": 1
}
{
  "status": 0,
  "data": {
    "id": 12,
    "class_name": "礼品类",
    "is_show": 1,
    "is_fast": 1,
    "gift_pic_url": "https://t7.baidu.com/it/u=1819248061,230866778&fm=193&f=GIF"
  }
}

HTTP Method

PUT

HTTP Request

/gift/classify/{id}

Request Parameters Query

Parameter Description Type Required Explain
class_name 礼品分类名称 String 非必填
gift_pic_url 礼品分类图片url 选填 如果是首页的分类有这项 String 非必填
is_fast 是否首页和快速匹配 2-否 1-是 int 非必填
is_show 是否展示 2-不展示 1-展示 3-软删除 int 非必填

Request Parameters Body

Response Data

Title Description Type Tips
id Classify ID Int
class_name 礼品分类名称 String
gift_pic_url 礼品分类图片url String
is_fast 是否首页和快速匹配 2-否 1-是 int
is_show 是否展示 2-不展示 1-展示 3-软删除 int

Gift

Title Description Type Tips
id Classify ID Int

Error

Code Message Description
201 GIFT ID format error 参数不能为空 或者 id错误
202 GIFT Page Not Found 不存在数据
203 This GiftPic's sql The problem sql问题
204 上传失败

Log

日期 作者 内容
2021/04/09 张宏伟 新增

获取礼品列表数据

GIFT_LIST

GET: /api/gift?search_name=马克杯&class=1

{
  "status": 0,
  "current_page": 1,
  "last_page": 1,
  "total": 1,
  "data": [
    {
      "id": 1,
      "gift_name": "马克杯",
      "gift_pic": [
        "https//:www.baidu.com"
      ],
      "classify_id": 1,
      "use_class_id": 1,
      "texture": "陶瓷",
      "gift_plan": "好的"
    }
  ]
}

HTTP Method

GET

HTTP Request

/gift

Request Parameters Query

Parameter Description Required Explain
search_name 名称搜索 模糊搜索
class 分类id
is_fast 是否首页和快速匹配 2-否 1-是 通过分类查询时必传 其他可不传
limit 每页个数 默认10

Request Parameters Body

Response Data

Title Description
current_page 当前页面页码
last_page 最后一页页码
total 该资源的全部数量

Gift Object

Title Description Type Tips
id gift ID Int
gift_name 礼品名称 String
classify_id 礼品分类 int
gift_pic 礼品展示图 array
use_class_id 用途分类 关联礼品分类表id Int
texture 材质 String
gift_plan 礼品定制方案 String

Error

Log

日期 作者 内容
2021/03/29 张宏伟 新增

插入一条新的礼品信息

GIFT_NEW

一条新的礼品信息

POST: /api/gift

{
  "gift_name": "保温杯",
  "gift_pic": "https//:www.baidu.com,https//:www.alibaba.com",
  "classify_id": 1,
  "use_class_id": 2,
  "texture": "不锈钢",
  "gift_plan": "保温"
}
{
  "status": 0,
  "data": {
    "gift_name": "保温杯",
    "gift_pic_url": "https//:www.alibaba.com,https//:www.alibaba.com",
    "classify_id": "1",
    "use_class_id": "2",
    "texture": "不锈钢",
    "gift_plan": "保温"
  }
}

HTTP Method

POST

HTTP Request

/gift

Request Parameters Query

Request Parameters Body

Parameter Description Type Required Explain
gift_name 礼品名称 String 必填
gift_pic_url 礼品图片url ','逗号分割 string 必填
classify_id 礼品分类id 多个用逗号链接 String 必填
use_class_id 用途分类 关联礼品分类表id 多个用逗号链接 String 必填
texture 材质 String 必填
gift_plan 礼品定制方案 String

Response Data

Title Description Type Tips
gift_name 礼品名称 String
gift_pic_url 礼品图片url string
classify_id 礼品分类 多个用逗号链接 string
use_class_id 用途分类 关联礼品分类表id 多个用逗号链接 string
texture 材质 String
gift_plan 礼品定制方案 String

Error

Code Message Description
203 Insert failed: 插入失败
202 This Gift sql The problem sql问题

Log

日期 作者 内容
2021/03/29 张宏伟 新增

修改礼品信息

GIFT_UPD

修改礼品信息

PUT: /api/gift/1

{
  "gift_name": "保温杯",
  "gift_pic_url": [
    {
      "id": 1,
      "pic_url": "https://t7.baidu.com/it/u=1819248061,230866778&fm=193&f=GIF"
    }
  ],
  "classify_id": "1",
  "use_class_id": "2",
  "texture": "不锈钢",
  "gift_plan": "保温"
}
{
  "status": 0,
  "data": {
    "id": 19,
    "gift_name": "护腰垫",
    "classify_id": "9",
    "use_class_id": "12",
    "texture": "塑料,电子原件",
    "gift_plan": "护腰垫"
  }
}

HTTP Method

PUT

HTTP Request

/gift/{id}

Request Parameters Query

Parameter Description Type Required Explain
gift_name 礼品名称 String 非必填
gift_pic_url 礼品图片url 数组 id图片id pic_url图片路径 array 非必填
classify_id 礼品分类 多个用逗号链接 string 非必填
use_class_id 用途分类 关联礼品分类表id 多个用逗号链接 string 非必填
texture 材质 String 非必填
gift_plan 礼品定制方案 String 非必填

Request Parameters Body

Response Data

Title Description Type Tips
id Gift ID Int
gift_name 礼品名称 String
classify_id 礼品分类 多个用逗号链接 string
use_class_id 用途分类 关联礼品分类表id 多个用逗号链接 string
texture 材质 String
gift_plan 礼品定制方案 String

Gift

Title Description Type Tips
id Gift ID Int

Error

Code Message Description
201 GIFT ID format error 参数不能为空 或者 id错误
202 GIFT Page Not Found 不存在数据
203 This GiftPic's sql The problem sql问题
204 上传失败

Log

日期 作者 内容
2021/03/29 张宏伟 新增

获取礼品信息

GIFT_INFO

获取礼品信息

GET: /api/gift/1

{
  "status": 0,
  "data": {
    "id": 1,
    "gift_name": "陶瓷杯",
    "classify_id": "1",
    "use_class_id": "12",
    "texture": "陶瓷",
    "gift_plan": "好的",
    "gift_pic": [
      {
        "id": 1,
        "pic_url": "https://t7.baidu.com/it/u=1819248061,230866778&fm=193&f=GIF"
      },
      {
        "id": 2,
        "pic_url": "https://gimg2.baidu.com/image_search/src=http%3A%2F%2Fm.360buyimg.com%2Fn12%2Fjfs%2Ft700%2F143%2F394068553%2F135691%2F708046c3%2F54ace968Nd0af7656.jpg%21q70.jpg&refer=http%3A%2F%2Fm.360buyimg.com&app=2002&size=f9999,10000&q=a80&n=0&g=0n&fmt=jpeg?sec=16199"
      },
      {
        "id": 3,
        "pic_url": "https://gimg2.baidu.com/image_search/src=http%3A%2F%2Fimg.zcool.cn%2Fcommunity%2F01474055447e350000019ae9fe5540.jpg%401280w_1l_2o_100sh.jpg&refer=http%3A%2F%2Fimg.zcool.cn&app=2002&size=f9999,10000&q=a80&n=0&g=0n&fmt=jpeg?sec=1619940649&t=68f580a9a14ce33a"
      },
      {
        "id": 4,
        "pic_url": "https://gimg2.baidu.com/image_search/src=http%3A%2F%2Fimg.improve-yourmemory.com%2Fpic%2Fee11bd678e9908611d92405c9c06bcaf-2.jpg&refer=http%3A%2F%2Fimg.improve-yourmemory.com&app=2002&size=f9999,10000&q=a80&n=0&g=0n&fmt=jpeg?sec=1619940649&t=53ef334c7a8eae"
      },
      {
        "id": 5,
        "pic_url": "https://gimg2.baidu.com/image_search/src=http%3A%2F%2Fimage5.suning.cn%2Fuimg%2Fb2c%2Fnewcatentries%2F0070179412-000000010027796833_2_800x800.jpg&refer=http%3A%2F%2Fimage5.suning.cn&app=2002&size=f9999,10000&q=a80&n=0&g=0n&fmt=jpeg?sec=1619940649&t=ca7a30"
      },
      {
        "id": 6,
        "pic_url": "https://ss2.bdstatic.com/70cFvnSh_Q1YnxGkpoWK1HF6hhy/it/u=292938248,1980252216&fm=26&gp=0.jpg"
      }
    ]
  }
}

HTTP Method

GET

HTTP Request

/gift/{id}

Request Parameters Query

Request Parameters Body

Response Data

Gift Object

Title Description Type Tips
id Gift ID Int
gift_name 礼品名 Int
classify_id 所属分类 关联礼品分类表id String
use_class_id 用途分类 关联礼品分类表id String
texture 材质 String
gift_plan 礼品定制方案 String
gift_pic 礼品图片 id url array

Log

日期 作者 内容
2021/04/12 张宏伟 新增

删除礼品图片

GIFT_PIC_DELETE

删除礼品图片

DELETE: /api/gift/pic/55

{
  "status": 0,
  "id": "55"
}

HTTP Method

DELETE

HTTP Request

/gift/pic/{id}

Request Parameters Query

Request Parameters Body

Response Data

Error

Code Message Description
201 GIFT ID format error id问题
202 GIFT PIC error 删除失败

Log

日期 作者 内容
2021/04/14 张宏伟 新增

礼品管理修改图片

GIFT_PIC_UPD

礼品管理修改图片

PUT: /api/gift/pic/57

{
  "pic_url": "jwImg/73a7905c9501f837.png",
  "is_slide": 4
}
{
  "status": 0,
  "data": {
    "id": 57,
    "pic_url": "jwImg/73a7905c9501f837.png",
    "is_slide": "4"
  }
}

HTTP Method

PUT

HTTP Request

/gift/pic/{id}

Request Parameters Query

Parameter Description Type Required Explain
is_slide 图片位置 2-轮播图 4-详情页顶部 int 必填
pic_url 图片路径 string 必填

Request Parameters Body

Response Data

Title Description Type Tips
id Gift ID Int
is_slide 图片位置 2-轮播图 4-详情页顶部
pic_url 图片路径

Gift

Title Description Type Tips
id GiftPIC ID Int

Error

Code Message Description
201 GIFT ID format error 参数不能为空 或者 id错误
202 GIFT Page Not Found 不存在数据
204 上传失败

Log

日期 作者 内容
2021/04/14 张宏伟 新增

礼品管理图片列表

GIFT_PIC_LIST

GET: /api/gift/pic?is_slide=4

{
  "status": 0,
  "current_page": 1,
  "last_page": 1,
  "total": 3,
  "data": [
    {
      "id": 35,
      "pic_url": "https://t7.baidu.com/it/u=3124693600,356058981&fm=193&f=GIF",
      "is_slide": "详情页顶部"
    },
    {
      "id": 36,
      "pic_url": "https://t7.baidu.com/it/u=3124693600,356058981&fm=193&f=GIF",
      "is_slide": "详情页顶部"
    },
    {
      "id": 57,
      "pic_url": "jwImg/73a7905c9501f837.png",
      "is_slide": "详情页顶部"
    }
  ]
}

HTTP Method

GET

HTTP Request

/gift/pic

Request Parameters Query

Parameter Description Required Explain
is_slide 位置搜索 2-轮播图 4-详情页顶部 精确搜索
limit 每页个数 默认10

Request Parameters Body

Response Data

Title Description
current_page 当前页面页码
last_page 最后一页页码
total 该资源的全部数量

Gift Object

Title Description Type Tips
id gift ID Int
pic_url 图片url String
is_slide 图片位置 String

Error

Log

日期 作者 内容
2021/04/14 张宏伟 新增

礼品管理图片详情

GIFT_PIC_INFO

礼品管理图片详情

GET: /api/gift/pic/57

{
  "status": 0,
  "data": {
    "id": 57,
    "pic_url": 57,
    "is_slide": 57
  }
}

HTTP Method

GET

HTTP Request

/gift/pic/{id}

Request Parameters Query

Request Parameters Body

Response Data

Gift PIC Object

Title Description Type Tips
id PIC ID Int
pic_url 图片url String
is_slide 图片位置 2-轮播图 4-详情页顶部 int

Log

日期 作者 内容
2021/04/14 张宏伟 新增

礼品管理新增图片

GIFT_PIC_NEW

礼品管理新增图片

POST: /api/gift/pic

{
  "pic_url": "jwImg/73a7905c9501f837.png",
  "is_slide": 2,
}
{
  "status": 0,
  "data": {
    "id": 66,
    "pic_url": "jwImg/73a7905c9501f837.png"
  }
}

HTTP Method

POST

HTTP Request

/gift/pic

Request Parameters Query

Request Parameters Body

Parameter Description Type Required Explain
pic_url 图片url String 必填
is_slide 图片位置 2-轮播图 4-详情页顶部 int 必填

Response Data

Title Description Type Tips
id 图片id int
pic_url 图片url String
is_slide 图片位置 2-轮播图 4-详情页顶部 int

Error

Code Message Description
202 Insert failed: 插入失败

Log

日期 作者 内容
2021/04/14 张宏伟 新增

消息列表 message

获取消息列表数据的信息

接口地址

/message

请求方式

POST

请求参数

BODY

参数 类型 说明
title string 标题
content string 消息
type int 通知1 升级2

请求示例

{
    "title": "给全部人的通知!!",
    "content": "萨达四大",
    "type":2
}

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list object 管理员(AdminUser:Object)对象

AdminUser:Object 管理员

参数 类型 说明
id int
title string 标题
content string 内容
author_name string 作者
send_count int 发送次数
read_count int 阅读次数
created_time int 创建时间

返回示例

{
    "status": 0,
    "data": {
        "id": 7,
        "title": "给全部人的通知!!",
        "content": "萨达四大",
        "send_count": 58
        "read_count": 0,
        "created_time": 1605076987
    }
}

Status返回值

获取消息列表数据的信息

接口地址

/message

请求方式

GET

请求参数

参数 类型 说明
search string 搜索
type int 消息类型

请求示例

返回参数

参数 类型 说明
status int Api Code
error string Api Error Message
list array 管理员(AdminUser:Object)对象

AdminUser:Object 管理员

参数 类型 说明
id int
title string 标题
content string 内容
author_nam string 作者
send_count int 发送次数
read_count int 阅读次数
created_time int 创建时间

返回示例

{
{
    "status": 0,
    "current_page": 1,
    "last_page": 1,
    "total": 6,
    "data": [
        {
            "id": 1,
            "title": null,
            "content": "奥术大师大所",
            "author_name": "测试账号",
            "send_count": 58,
            "read_count": 0,
            "created_time": 1605076641
        },
        {
            "id": 2,
            "title": null,
            "content": "奥术大师大所",
            "author_name": "测试账号",
            "send_count": 58,
            "read_count": 0,
            "created_time": 1605076686
        },
        {
            "id": 3,
            "title": null,
            "content": "奥术大师大所",
            "author_name": "测试账号",
            "send_count": 58,
            "read_count": 0,
            "created_time": 1605076887
        },
        {
            "id": 4,
            "title": null,
            "content": "奥术大师大所",
            "author_name": "测试账号",
            "send_count": 58,
            "read_count": 0,
            "created_time": 1605076909
        },
        {
            "id": 5,
            "title": null,
            "content": "奥术大师大所",
            "author_name": "测试账号",
            "send_count": 58,
            "read_count": 0,
            "created_time": 1605076921
        },
        {
            "id": 6,
            "title": null,
            "content": "萨达四大",
            "author_name": "测试账号",
            "send_count": 58,
            "read_count": 0,
            "created_time": 1605076987
        }
    ]
}

Status返回值

报名模板

报名模板列表

接口地址

/api/saas/apply

请求方式

GET

请求参数

Query Param

参数 类型 必填 说明 版本
name string 模板名称 2022 10月份 迭代
type int 模板类型 1学生报名 2企业报名 2022 10月份 迭代
bind_status int 模板名称 1已关联 2未关联 2022 10月份 迭代
page int 分页 页数 默认 1 2022 10月份 迭代
limit int 每页 个数 默认 8 2022 10月份 迭代

请求示例

返回参数

参数 类型 说明 版本
id int 序号 2022 10月份 迭代
name string 模板名称 2022 10月份 迭代
type int 使用类型 2022 10月份 迭代
template_id int 使用类id 2022 10月份 迭代
apply_page_id int 报名页id 2022 10月份 迭代
manager userObject 创建人 2022 10月份 迭代
status int 上架状态 1为上架 0为下架 2022 10月份 迭代
bind_status int 绑定状态 1绑定 0未绑定 2022 10月份 迭代
created_at int 创建时间 2022 10月份 迭代

manager

参数 类型 说明 版本
id int 用户ID 2022 10月份 迭代
nickname string 用户昵称 2022 10月份 迭代

返回示例

{
  "status": 0,
  "current_page": 1,
  "last_page": 3,
  "total": 21,
  "yesterday": 1,
  "data": [
    {
      "id": 1,
      "name": "2022秋招学生报名模板",
      "type": "学生报名",
      "template_id": 2,
      "apply_page_id": 2,
      "bind_status": 0,
      "manager": {
        "id": 23,
        "nickname": "admin"
      },
      "status": 1,
      "created_at": 1425242560
    }
  ]
}

Status返回值

Log

日期 作者 内容
2022/10/19 李世星 修改

新建报名模板

接口地址

/api/saas/apply

请求方式

POST

请求参数

JSON Body Param

参数 类型 必填 说明 版本
name string 模板名称 2022 10月份 迭代
is_login int 模板是否强制登录 0为 不强制 1 为强制
title string 模板标题 2022 10月份 迭代
type int 模板类型 1学生报名 2企业报名 2022 10月份 迭代
description string 模板描述 2022 10月份 迭代
modules Array 表单配置 2022 10月份 迭代

modules

参数 类型 必填 说明 版本
required bool 是否必填 2022 10月份 迭代
order int 排序号 2022 10月份 迭代
label string 表单输入框名称 2022 10月份 迭代
field string 字段值(用于提交) 2022 10月份 迭代
value string 组件默认值 2022 10月份 迭代
logic_id int 组件逻辑ID,用来处理逻辑组件关系 2022 10月份 迭代
placeholder bool 占位符 2022 10月份 迭代
full_module bool 是否展示组件label 2022 10月份 迭代
display bool 是否展示(根据logic计算) 2022 10月份 迭代
editable bool 是否可编辑 2022 10月份 迭代
tips string 组件提示 2022 10月份 迭代
engine engineObject 组件引擎配置 2022 10月份 迭代
regx_list array 组件校验规则列表 列:[{"name":"xxx1","expression":"/[一-龥豈-鶴]/","error_message":"包含无效字符"}] 2022 10月份 迭代
resource array 组件资源 2022 10月份 迭代
style array 组件样式 2022 10月份 迭代

engineObject

参数 类型 必填 说明 版本
name stirng 引擎名称 2022 10月份 迭代
config configObject 引擎配置 2022 10月份 迭代

请求示例

{
  "type":1,
  "is_login": 1,
  "name": "测试表单标题1",
  "title":"测试表单标题1",
  "description":"这是一条测试数据",
  "modules":[
    {
      "label":"姓名",
      "value":"1",
      "logic_id":1,
      "placeholder":false,
      "full_module":true,
      "display":true,
      "editable":true,
      "tips":"请输入姓名",
      "engine":{
        "name" : "SimpleText",
        "config" : {
          "maxInputlength" : 8
        }
      },
      "regx_list":[
        {
          "expression":"/[一-龥豈-鶴]/",
          "error_message":"包含无效字符"
        }
      ],
      "resource":[],
      "style":[]
    }
  ]
}

返回参数

参数 类型 说明 版本
id int 模板ID 2022 10月份 迭代
name string 模板名称 2022 10月份 迭代
type int 模板类型 1学生报名 2企业报名 2022 10月份 迭代
intro string 模板简介 2022 10月份 迭代
status int 上架状态 1为上架 0为下架 2022 10月份 迭代
bind_status int 上架状态 1为上架 0为下架 2022 10月份 迭代
apply_page apply_page Object 报名页详情 2022 10月份 迭代
contents contentsObject 报名模板详情 2022 10月份 迭代
created_at int 创建时间 2022 10月份 迭代
updated_at int 更新时间 2022 10月份 迭代

contents

参数 类型 说明 版本
id int 详情id 2022 10月份 迭代
unit_id int 模板id 2022 10月份 迭代
module_id int 模块id 2022 10月份 迭代
content string 详情介绍 2022 10月份 迭代

apply_page

参数 类型 说明 版本
id int 报名页ID 2022 10月份 迭代
name string 报名页名称 2022 10月份 迭代
author int 创建者ID 2022 10月份 迭代
option_count string 输入框数量 2022 10月份 迭代
status string page页 状态 0为下线 1为上线 2022 10月份 迭代
info info Object 表单详情 2022 10月份 迭代

info

参数 类型 说明 版本
id int 表单id 2022 10月份 迭代
name string 表单名称 2022 10月份 迭代
description int 表单描述 2022 10月份 迭代
source string xxx 2022 10月份 迭代
bg_img string xxx 2022 10月份 迭代
status int 表单状态 0为禁用 1为启用 2022 10月份 迭代
modules array 组件列表 2022 10月份 迭代

modules

参数 类型 说明 版本
id int 组件id 2022 10月份 迭代
form_id int 表单id 2022 10月份 迭代
label string 组件名称 2022 10月份 迭代
field string 表单提交内容 2022 10月份 迭代
logic_id int 组件关联逻辑id 2022 10月份 迭代
description string 组件描述 2022 10月份 迭代
tips string 组件提示语 2022 10月份 迭代
value string 组件默认值 2022 10月份 迭代
placeholder string 占位符 2022 10月份 迭代
is_show int 是否显示 2022 10月份 迭代
is_disable int 是否选中 2022 10月份 迭代
order int 排序号 2022 10月份 迭代
resource array 资源列表 2022 10月份 迭代
regx_list array 占位符 2022 10月份 迭代
engine engineObject 占位符 2022 10月份 迭代

modules[0].resource

参数 类型 说明 版本
id int 资源ID 2022 10月份 迭代
type int 资源类型1本地资源 2远程资源 2022 10月份 迭代
title string 资源名称 2022 10月份 迭代
options array 本地资源列表 2022 10月份 迭代
api_setting array 远程资源 type为1时,该值为null 2022 10月份 迭代

modules[0].resource[0].options

参数 类型 说明 版本
label stirng 资源名称 2022 10月份 迭代
value string 资源值 2022 10月份 迭代
event object 事件 object 2022 10月份 迭代

modules[0].resource[0].options[0].event

参数 类型 说明 版本
event_type string 事件类型 hidden隐藏、show展示、editable编辑、disabled禁用 2022 10月份 迭代
link_module array(integer) 组件ID列表 array(integer) 2022 10月份 迭代

modules[0].regx_list

参数 类型 说明 版本
id int 校验ID 2022 10月份 迭代
name string 校验规则名称 2022 10月份 迭代
expression string 校验规则 2022 10月份 迭代
error_message string 错误提示 2022 10月份 迭代

modules[0].engine

参数 类型 说明 版本
name string 引擎名称 2022 10月份 迭代
config object 引擎配置(键值对,服务端不关心具体内容) 2022 10月份 迭代

返回示例

{
  "status": 0,
  "data": {
    "id": 1,
    "name": "测试表单标题1",
    "template_id": 2,
    "apply_page_id": 1,
    "author": 0,
    "status": 0,
    "bind_status": 0,
    "type": 1,
    "created_at": 1670385181,
    "updated_at": 1670385181,
    "apply_page": {
      "id": 1,
      "name": "测试表单标题1",
      "author": 0,
      "option_count": 1,
      "status": 1,
      "is_login": 1,
      "form_id": 240,
      "form_version": "b2b82c38e0b524ff1abaffa2f57d12a6",
      "created_at": 1670385181,
      "updated_at": 1670385181,
      "info": {
        "id": 240,
        "name": "测试表单标题1",
        "description": "这是一条测试数据",
        "source": 0,
        "bg_img": "",
        "status": 0,
        "modules": [
          {
            "id": 509,
            "form_id": 240,
            "label": "姓名",
            "field": "1",
            "logic_id": 0,
            "description": null,
            "tips": "请输入姓名",
            "value": "1",
            "placeholder": "xxx",
            "is_show": null,
            "is_disable": null,
            "order": 0,
            "resource": [],
            "regx_list": [
              {
                "id": 238,
                "name": null,
                "expression": "/[一-龥豈-鶴]/",
                "error_message": "包含无效字符"
              }
            ],
            "engine": {
              "name": "SimpleText",
              "config": [
                {
                  "maxInputlength": "8"
                }
              ]
            }
          }
        ]
      }
    },
    "contents": {
      "id": 1,
      "unit_id": 1,
      "module_id": 1,
      "content": "这是一条测试数据",
      "created_at": 1670385181,
      "updated_at": 1670385181
    }
  }
}

Status返回值

Log

日期 作者 内容
2022/10/19 李世星 修改

查看报名模板详情

接口地址

/api/saas/apply/3

请求方式

GET

请求参数

请求示例

返回参数

参数 类型 说明 版本
id int 模板ID 2022 10月份 迭代
name string 模板名称 2022 10月份 迭代
type int 模板类型 1学生报名 2企业报名 2022 10月份 迭代
intro string 模板简介 2022 10月份 迭代
status int 上架状态 1为上架 0为下架 2022 10月份 迭代
bind_status int 上架状态 1为上架 0为下架 2022 10月份 迭代
apply_page apply_page Object 报名页详情 2022 10月份 迭代
contents contentsObject 报名模板详情 2022 10月份 迭代
created_at int 创建时间 2022 10月份 迭代
updated_at int 更新时间 2022 10月份 迭代

contents

参数 类型 说明 版本
id int 详情id 2022 10月份 迭代
unit_id int 模板id 2022 10月份 迭代
module_id int 模块id 2022 10月份 迭代
content string 详情介绍 2022 10月份 迭代

apply_page

参数 类型 说明 版本
id int 报名页ID 2022 10月份 迭代
name string 报名页名称 2022 10月份 迭代
author int 创建者ID 2022 10月份 迭代
option_count string 输入框数量 2022 10月份 迭代
status string page页 状态 0为下线 1为上线 2022 10月份 迭代
info info Object 2022 10月份 迭代

info

参数 类型 说明 版本
id int 2022 10月份 迭代
name string 表单名称 2022 10月份 迭代
description int 表单描述 2022 10月份 迭代
source string xxx 2022 10月份 迭代
bg_img string xxx 2022 10月份 迭代
status int 表单状态 0为禁用 1为启用 2022 10月份 迭代
modules array 组件列表 2022 10月份 迭代

modules

参数 类型 说明 版本
id int 组件id 2022 10月份 迭代
form_id int 表单id 2022 10月份 迭代
label string 组件名称 2022 10月份 迭代
field string 表单提交内容 2022 10月份 迭代
logic_id int 组件关联逻辑id 2022 10月份 迭代
description string 组件描述 2022 10月份 迭代
tips string 组件提示语 2022 10月份 迭代
value string 组件默认值 2022 10月份 迭代
placeholder string 占位符 2022 10月份 迭代
is_show int 是否显示 2022 10月份 迭代
is_disable int 是否选中 2022 10月份 迭代
order int 排序号 2022 10月份 迭代
resource array 资源列表 2022 10月份 迭代
regx_list array 占位符 2022 10月份 迭代
engine engineObject 占位符 2022 10月份 迭代

modules[0].resource

参数 类型 说明 版本
id int 资源ID 2022 10月份 迭代
type int 资源类型1本地资源 2远程资源 2022 10月份 迭代
title string 资源名称 2022 10月份 迭代
options array 本地资源列表 2022 10月份 迭代
api_setting array 远程资源 type为1时,该值为null 2022 10月份 迭代

modules[0].resource[0].options

参数 类型 说明 版本
label stirng 资源名称 2022 10月份 迭代
value string 资源值 2022 10月份 迭代
event object 事件 object 2022 10月份 迭代

modules[0].resource[0].options[0].event

参数 类型 说明 版本
event_type string 事件类型 hidden隐藏、show展示、editable编辑、disabled禁用 2022 10月份 迭代
link_module array(integer) 组件ID列表 array(integer) 2022 10月份 迭代

modules[0].regx_list

参数 类型 说明 版本
id int 校验ID 2022 10月份 迭代
name string 校验规则名称 2022 10月份 迭代
expression string 校验规则 2022 10月份 迭代
error_message string 错误提示 2022 10月份 迭代

modules[0].engine

参数 类型 说明 版本
name string 引擎名称 2022 10月份 迭代
config object 引擎配置(键值对,服务端不关心具体内容) 2022 10月份 迭代

返回示例

{
  "status": 0,
  "data": {
    "id": 1,
    "name": "测试表单标题1",
    "template_id": 2,
    "apply_page_id": 1,
    "author": 0,
    "status": 0,
    "bind_status": 0,
    "type": 1,
    "created_at": 1670385181,
    "updated_at": 1670385181,
    "apply_page": {
      "id": 1,
      "name": "测试表单标题1",
      "author": 0,
      "option_count": 1,
      "status": 1,
      "is_login": 1,
      "form_id": 240,
      "form_version": "b2b82c38e0b524ff1abaffa2f57d12a6",
      "created_at": 1670385181,
      "updated_at": 1670385181,
      "info": {
        "id": 240,
        "name": "测试表单标题1",
        "description": "这是一条测试数据",
        "source": 0,
        "bg_img": "",
        "status": 0,
        "modules": [
          {
            "id": 509,
            "form_id": 240,
            "label": "姓名",
            "field": "1",
            "logic_id": 0,
            "description": null,
            "tips": "请输入姓名",
            "value": "1",
            "placeholder": "xxx",
            "is_show": null,
            "is_disable": null,
            "order": 0,
            "resource": [],
            "regx_list": [
              {
                "id": 238,
                "name": null,
                "expression": "/[一-龥豈-鶴]/",
                "error_message": "包含无效字符"
              }
            ],
            "engine": {
              "name": "SimpleText",
              "config": [
                {
                  "maxInputlength": "8"
                }
              ]
            }
          }
        ]
      }
    },
    "contents": {
      "id": 1,
      "unit_id": 1,
      "module_id": 1,
      "content": "这是一条测试数据",
      "created_at": 1670385181,
      "updated_at": 1670385181
    }
  }
}

Status返回值

Log

日期 作者 内容
2022/10/19 李世星 修改

修改报名模板

接口地址

/api/saas/apply/3

请求方式

PUT

请求参数

JSON Body Param

参数 类型 必填 说明 版本
name string 模板名称 2022 10月份 迭代
is_login int 模板是否强制登录 0为 不强制 1 为强制
title string 模板标题 2022 10月份 迭代
type int 模板类型 1学生报名 2企业报名 2022 10月份 迭代
description string 模板描述 2022 10月份 迭代
modules Array 表单配置 2022 10月份 迭代

modules

参数 类型 必填 说明 版本
id int 修改指定组件时必填 2022 10月份 迭代
required bool 是否必填 2022 10月份 迭代
order int 排序号 2022 10月份 迭代
label string 表单输入框名称 2022 10月份 迭代
field string 字段值(用于提交) 2022 10月份 迭代
value string 组件默认值 2022 10月份 迭代
logic_id int 组件逻辑ID,用来处理逻辑组件关系 2022 10月份 迭代
placeholder bool 占位符 2022 10月份 迭代
full_module bool 是否展示组件label 2022 10月份 迭代
display bool 是否展示(根据logic计算) 2022 10月份 迭代
editable bool 是否可编辑 2022 10月份 迭代
tips string 组件提示 2022 10月份 迭代
engine engineObject 组件引擎配置 2022 10月份 迭代
regx_list array 组件校验规则列表 列:[{"id":1,"name":"xxx1","expression":"/[一-龥豈-鶴]/","error_message":"包含无效字符"}] 2022 10月份 迭代
resource array 组件资源 2022 10月份 迭代
style array 组件样式 2022 10月份 迭代

engineObject

参数 类型 必填 说明 版本
name stirng 引擎名称 2022 10月份 迭代
config configObject 引擎配置 2022 10月份 迭代

请求示例

返回参数

参数 类型 说明 版本
id int 模板ID 2022 10月份 迭代
name string 模板名称 2022 10月份 迭代
type int 模板类型 1学生报名 2企业报名 2022 10月份 迭代
intro string 模板简介 2022 10月份 迭代
status int 上架状态 1为上架 0为下架 2022 10月份 迭代
bind_status int 上架状态 1为上架 0为下架 2022 10月份 迭代
apply_page apply_page Object 报名页详情 2022 10月份 迭代
contents contentsObject 报名模板详情 2022 10月份 迭代
created_at int 创建时间 2022 10月份 迭代
updated_at int 更新时间 2022 10月份 迭代

contents

参数 类型 说明 版本
id int 详情id 2022 10月份 迭代
unit_id int 模板id 2022 10月份 迭代
module_id int 模块id 2022 10月份 迭代
content string 详情介绍 2022 10月份 迭代

apply_page

参数 类型 说明 版本
id int 报名页ID 2022 10月份 迭代
name string 报名页名称 2022 10月份 迭代
author int 创建者ID 2022 10月份 迭代
option_count string 输入框数量 2022 10月份 迭代
status string page页 状态 0为下线 1为上线 2022 10月份 迭代
info info Object 2022 10月份 迭代

info

参数 类型 说明 版本
id int 2022 10月份 迭代
name string 表单名称 2022 10月份 迭代
description int 表单描述 2022 10月份 迭代
source string xxx 2022 10月份 迭代
bg_img string xxx 2022 10月份 迭代
status int 表单状态 0为禁用 1为启用 2022 10月份 迭代
modules array 组件列表 2022 10月份 迭代

modules

参数 类型 说明 版本
id int 组件id 2022 10月份 迭代
form_id int 表单id 2022 10月份 迭代
label string 组件名称 2022 10月份 迭代
field string 表单提交内容 2022 10月份 迭代
logic_id int 组件关联逻辑id 2022 10月份 迭代
description string 组件描述 2022 10月份 迭代
tips string 组件提示语 2022 10月份 迭代
value string 组件默认值 2022 10月份 迭代
placeholder string 占位符 2022 10月份 迭代
is_show int 是否显示 2022 10月份 迭代
is_disable int 是否选中 2022 10月份 迭代
order int 排序号 2022 10月份 迭代
resource array 资源列表 2022 10月份 迭代
regx_list array 占位符 2022 10月份 迭代
engine engineObject 占位符 2022 10月份 迭代

modules[0].resource

参数 类型 说明 版本
id int 资源ID 2022 10月份 迭代
type int 资源类型1本地资源 2远程资源 2022 10月份 迭代
title string 资源名称 2022 10月份 迭代
options array 本地资源列表 2022 10月份 迭代
api_setting array 远程资源 type为1时,该值为null 2022 10月份 迭代

modules[0].resource[0].options

参数 类型 说明 版本
label stirng 资源名称 2022 10月份 迭代
value string 资源值 2022 10月份 迭代
event object 事件 object 2022 10月份 迭代

modules[0].resource[0].options[0].event

参数 类型 说明 版本
event_type string 事件类型 hidden隐藏、show展示、editable编辑、disabled禁用 2022 10月份 迭代
link_module array(integer) 组件ID列表 array(integer) 2022 10月份 迭代

modules[0].regx_list

参数 类型 说明 版本
id int 校验ID 2022 10月份 迭代
name string 校验规则名称 2022 10月份 迭代
expression string 校验规则 2022 10月份 迭代
error_message string 错误提示 2022 10月份 迭代

modules[0].engine

参数 类型 说明 版本
name string 引擎名称 2022 10月份 迭代
config object 引擎配置(键值对,服务端不关心具体内容) 2022 10月份 迭代

返回示例

{
  "status": 0,
  "data": {
    "id": 1,
    "name": "测试表单标题1",
    "template_id": 2,
    "apply_page_id": 1,
    "author": 0,
    "status": 0,
    "bind_status": 0,
    "type": 1,
    "created_at": 1670385181,
    "updated_at": 1670385181,
    "apply_page": {
      "id": 1,
      "name": "测试表单标题1",
      "author": 0,
      "option_count": 1,
      "status": 1,
      "is_login": 1,
      "form_id": 240,
      "form_version": "b2b82c38e0b524ff1abaffa2f57d12a6",
      "created_at": 1670385181,
      "updated_at": 1670385181,
      "info": {
        "id": 240,
        "name": "测试表单标题1",
        "description": "这是一条测试数据",
        "source": 0,
        "bg_img": "",
        "status": 0,
        "modules": [
          {
            "id": 509,
            "form_id": 240,
            "label": "姓名",
            "field": "1",
            "logic_id": 0,
            "description": null,
            "tips": "请输入姓名",
            "value": "1",
            "placeholder": "xxx",
            "is_show": null,
            "is_disable": null,
            "order": 0,
            "resource": [],
            "regx_list": [
              {
                "id": 238,
                "name": null,
                "expression": "/[一-龥豈-鶴]/",
                "error_message": "包含无效字符"
              }
            ],
            "engine": {
              "name": "SimpleText",
              "config": [
                {
                  "maxInputlength": "8"
                }
              ]
            }
          }
        ]
      }
    },
    "contents": {
      "id": 1,
      "unit_id": 1,
      "module_id": 1,
      "content": "这是一条测试数据",
      "created_at": 1670385181,
      "updated_at": 1670385181
    }
  }
}

Status返回值

Log

日期 作者 内容
2022/10/19 李世星 修改

获取模板对应报名列表

接口地址

api/saas/apply/{id}/attendee

请求方式

GET

请求参数

Query

参数 类型 必填 说明 版本
search string 微信昵称搜索 2022 10月份 迭代
code string 报名码搜素 2022 10月份 迭代

返回参数

参数 类型 说明 版本
status int Api Code 2022 10月份 迭代
current_page int 当前页 2022 10月份 迭代
last_page int 最后页 2022 10月份 迭代
total int 总条数 2022 10月份 迭代
data dataObject 2022 10月份 迭代

data Object

参数 类型 说明 版本
options option Array 参数列表 2022 10月份 迭代
attendees attendees Array 参数对应数据列表 2022 10月份 迭代

options

参数 类型 说明 版本
field string 组件标识id 2022 10月份 迭代
page_id int 报名模板页id 2022 10月份 迭代
input_name string label名称 2022 10月份 迭代

attendees Object

参数 类型 说明 版本
id int 报名人 ID 2022 10月份 迭代
code string 报名Code 2022 10月份 迭代
nick_name string 报名人名称 2022 10月份 迭代
avatar string 报名人头像 2022 10月份 迭代
gender string 数据排行ID 2022 10月份 迭代
mobile string 报名人手机号 2022 10月份 迭代
options string 报名人表单数据 2022 10月份 迭代

options

参数 类型 说明 版本
field int 表数据ID 2022 10月份 迭代
page_id int 活动报名模板页id 2022 10月份 迭代
input_name string 数据对应表头 2022 10月份 迭代
content String 表数据 2022 10月份 迭代

返回示例

{
  "status": 0,
  "current_page": 1,
  "last_page": 1,
  "total": 5,
  "data": {
    "options": [
      {
        "field": "1-1",
        "page_id": 1,
        "input_name": "姓名1"
      }
    ],
    "attendees": [
      {
        "id": 1,
        "code": "013I01",
        "nick_name": "",
        "avatar": "",
        "gender": 1,
        "mobile": "18334786948",
        "options": []
      },
      {
        "id": 2,
        "code": "031201",
        "nick_name": "微信用户",
        "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/POgEwh4mIHO4nibH0KlMECNjjGxQUq24ZEaGT4poC6icRiccVGKSyXwibcPq4BWmiaIGuG1icwxaQX6grC9VemZoJ8rg/132",
        "gender": 1,
        "mobile": "13651748505",
        "options": [
          {
            "field": "1-1",
            "page_id": 1,
            "input_name": "姓名1",
            "content": "李世星"
          },
          {
            "field": "",
            "page_id": null,
            "input_name": "",
            "content": "cv/annex/2020/06/28/15933398311532.pdf"
          },
          {
            "field": "",
            "page_id": null,
            "input_name": "",
            "content": "cv/annex/2022/08/01/16593540927114.docx"
          }
        ]
      },
      {
        "id": 3,
        "code": "010003",
        "nick_name": "",
        "avatar": "",
        "gender": "",
        "mobile": null,
        "options": []
      },
      {
        "id": 4,
        "code": "010004",
        "nick_name": "",
        "avatar": "",
        "gender": "",
        "mobile": null,
        "options": []
      },
      {
        "id": 5,
        "code": "010005",
        "nick_name": "",
        "avatar": "",
        "gender": "",
        "mobile": null,
        "options": [
          {
            "field": "1-1",
            "page_id": 1,
            "input_name": "姓名1",
            "content": "李世星"
          },
          {
            "field": "",
            "page_id": null,
            "input_name": "",
            "content": "李世星1"
          },
          {
            "field": "",
            "page_id": null,
            "input_name": "",
            "content": "/11111.jpg"
          }
        ]
      }
    ]
  }
}

Log

日期 作者 内容
2022/10/19 李世星 修改

表单导出

接口地址

api/saas/apply/{id}/attendee/export

请求方式

POST

请求参数

Query

参数 类型 必填 说明 版本
search string 微信昵称搜索 2022 10月份 迭代
code string 报名码搜素 2022 10月份 迭代

返回参数

参数 类型 说明 版本
status int Api Code 2022 10月份 迭代
error int 当前页 2022 10月份 迭代

返回示例



Log

日期 作者 内容
2022/10/19 李世星 修改

修改模板状态

接口地址

api/saas/apply/{id}/active

请求方式

PUT

请求参数

Body

参数 类型 必填 说明 版本
status int 模板状态 0为 下架 1 为上架 2022 10月份 迭代

返回参数

参数 类型 说明 版本
status int Api Code 2022 10月份 迭代
data object 当前报名模板详情 2022 10月份 迭代

data

参数 类型 说明 版本
id int 报名模板id 2022 10月份 迭代
name int 报名模板名称 2022 10月份 迭代
template_id xxxid 报名模板id 2022 10月份 迭代
apply_page_id 报名模板页id 报名模板id 2022 10月份 迭代
author int 管理员id 2022 10月份 迭代
status int 报名模板状态 0 为下架 1为上架 2022 10月份 迭代
bind_status int 报名模板 绑定状态 1为绑定 0 为未绑定 2022 10月份 迭代
type int 报名模板类型 2022 10月份 迭代
created_at int 创建时间 2022 10月份 迭代
created_at int 修改时间 2022 10月份 迭代
manager int 管理员 2022 10月份 迭代

manager

参数 类型 说明 版本
id int 管理员id 2022 10月份 迭代
nickname string 管理员昵称 2022 10月份 迭代

返回示例

{
    "status": 0,
    "data": {
        "id": 1,
        "name": "测试表单标题1",
        "template_id": 2,
        "apply_page_id": 1,
        "author": 1,
        "status": 1,
        "bind_status": 0,
        "type": 1,
        "created_at": 1670390109,
        "updated_at": 1670390250,
        "manager": {
            "id": 1,
            "nickname": "测试账号"
        }
    }
}

Log

日期 作者 内容
2022/10/19 李世星 修改

获取报名模板校验规则

接口地址

api/saas/apply/rule/search

请求方式

GET

请求参数

Query

返回参数

参数 类型 说明 版本
status int Api Code 2022 10月份 迭代
data array 校验规则列表 2022 10月份 迭代

data

参数 类型 说明 版本
id int 校验规则 id 2022 10月份 迭代
app_id int app id 2022 10月份 迭代
name string 校验规则名称 2022 10月份 迭代
expression string 校验规则 2022 10月份 迭代
error_message string 校验提示信息 2022 10月份 迭代

返回示例

{
  "status": 0,
  "data": [
    {
      "id": 37,
      "app_id": 1,
      "name": "必须是中文",
      "expression": "/[\\u4e00-\\u9fa5]/",
      "error_message": "包含无效字符"
    },
    {
      "id": 38,
      "app_id": 1,
      "name": "手机号",
      "expression": "/^1[34578]\\d{9}$/",
      "error_message": "手机号不符合格式"
    },
    {
      "id": 39,
      "app_id": 1,
      "name": "Test",
      "expression": "/^1[34578]\\d{9}$/",
      "error_message": "这是测试"
    }
  ]
}

Log

日期 作者 内容
2022/10/19 李世星 修改

报名模板表单资源检索

接口地址

api/saas/apply/resource/search

请求方式

GET

请求参数

Query

参数 类型 必填 说明 版本
type int 资源类型 1为 本地资源 2 为 远程资源 2022 10月份 迭代

返回参数

参数 类型 说明 版本
status int Api Code 2022 10月份 迭代
data array 资源列表 2022 10月份 迭代

data

参数 类型 说明 版本
id int 资源id 2022 10月份 迭代
app_id int 资源id 2022 10月份 迭代
type int 资源类型1本地资源 2远程资源 2022 10月份 迭代
title string 资源名称 2022 10月份 迭代
api_settings array 远程资源 type为1时,该值为null 2022 10月份 迭代
options array 本地资源详情 2022 10月份 迭代

options

参数 类型 说明 版本
id int options id
resource_id int 资源id 2022 10月份 迭代
label stirng 资源名称 2022 10月份 迭代
value string 资源值 2022 10月份 迭代
event object 事件 object 2022 10月份 迭代

options[0].event

参数 类型 说明 版本
event_type string 事件类型 hidden隐藏、show展示、editable编辑、disabled禁用 2022 10月份 迭代
link_module array(integer) 组件ID列表 array(integer) 2022 10月份 迭代

返回示例

{
  "status": 0,
  "data": [
    {
      "id": 23,
      "app_id": 1,
      "type": 1,
      "title": "选项是否",
      "api_settings": [],
      "options": [
        {
          "id": 186,
          "resource_id": 23,
          "label": "是",
          "value": "是",
          "event": {
            "event_type": "display_on",
            "link_module": [
              4,
              5
            ]
          }
        },
        {
          "id": 187,
          "resource_id": 23,
          "label": "否",
          "value": "否",
          "event": {
            "event_type": "display_off",
            "link_module": [
              4,
              5
            ]
          }
        }
      ]
    },
    {
      "id": 121,
      "app_id": 1,
      "type": 2,
      "title": "2021峰会校友会活动列表",
      "api_settings": [
        {
          "id": 167,
          "resource_id": 121,
          "uri": "https://www.fastmock.site/mock/532e60f1fc8ce344d5709c8f022f5cc7/api/school",
          "list_key": "data",
          "label_key": "label",
          "value_key": "value",
          "children_key": ""
        }
      ],
      "options": []
    },
    {
      "id": 133,
      "app_id": 1,
      "type": 1,
      "title": "选项是否",
      "api_settings": [],
      "options": []
    },
    {
      "id": 134,
      "app_id": 1,
      "type": 2,
      "title": "api",
      "api_settings": [],
      "options": []
    }
  ]
}

Log

日期 作者 内容
2022/10/19 李世星 修改

投递记录 position-cv

简历投递记录

接口地址

/cv/deliver

请求方式

GET

请求参数 body传参

Query

参数 类型 必填 说明 版本
name string 名称 2022 10月份 迭代
phone string 手机联系方式 2022 10月份 迭代
school string 学校 2022 10月份 迭代
major string 专业 2022 10月份 迭代
company_id int 公司id 2022 10月份 迭代
position_id int 职位id 2022 10月份 迭代
type int 投递类型 2022 10月份 迭代
start_ctime int 开始时间 2022 10月份 迭代
end_ctime int 结束时间 2022 10月份 迭代

返回参数

参数 类型 说明 版本
status int Api Code 2022 10月份 迭代
error string Api Error Message 2022 10月份 迭代
current_page int 当前页 2022 10月份 迭代
last_page int 最后页号 2022 10月份 迭代
per_page int 一页多少数据 2022 10月份 迭代
total int 数据总量 2022 10月份 迭代
data array 数据列表 2022 10月份 迭代

data

参数 类型 说明 版本
id int 记录 ID 2022 10月份 迭代
cv_id int 简历 ID 2022 10月份 迭代
name string 名称 2022 10月份 迭代
phone string 手机联系方式 2022 10月份 迭代
city string 城市 2022 10月份 迭代
school string 学校名称 2022 10月份 迭代
major string 专业名称 2022 10月份 迭代
position position Object 记录 ID 2022 10月份 迭代
company string 简历投递公司 2022 10月份 迭代
created_at int 简历投递时间 2022 10月份 迭代
status string 简历投递状态 2022 10月份 迭代
type string 投递类型 2022 10月份 迭代
jobshare string 双选会场次 2022 10月份 迭代
lines string 投递入口 2022 10月份 迭代

position

参数 类型 说明 版本
id int 职位ID ID 2022 10月份 迭代
name string 职位名称 2022 10月份 迭代
field position_field Object 职位归属 2022 10月份 迭代

field position_field

参数 类型 说明 版本
id int field ID 2022 10月份 迭代
name string 职能名称 2022 10月份 迭代

返回示例

{
  "status": 0,
  "list": [
    {
      "id": 22,
      "cv_id": 45520,
      "name": "姓名",
      "phone": "13333891144",
      "school": "洛阳理工学院",
      "major": "计算机科学与技术",
      "status": "已发出面试邀请",
      "position": {
        "id": 2,
        "name": "软件开发",
        "field": {
          "id": 4,
          "name": "互联网"
        }
      },
      "company": "爱集微",
      "created_at": 111111111,
      "jobshare": "上海场",
      "lines": "IOS",
      "type": "双选会"
    }
  ],
  "current_page": "当前页码",
  "last_page": "总页数",
  "per_page": "一页多少条",
  "total": "总条数"
}

Status返回值

状态码 原因

Log

日期 作者 内容
2022/10/19 李世星 新增

表单\附件导出

接口地址

cv/deliver/export

请求方式

POST

请求参数

Query

参数 类型 必填 说明 版本
name string 名称 2022 10月份 迭代
phone string 手机联系方式 2022 10月份 迭代
school string 学校 2022 10月份 迭代
major string 专业 2022 10月份 迭代
company int 选择企业 2022 10月份 迭代
p_type int 职位类别 2022 10月份 迭代
type int 投递类型 2022 10月份 迭代
cs_time int 开始时间 2022 10月份 迭代
ce_time int 结束时间 2022 10月份 迭代
export_type int 1 为表单导出 2 为附件导出 2022 10月份 迭代

返回参数

参数 类型 说明 版本
status int Api Code 2022 10月份 迭代
error int 当前页 2022 10月份 迭代

返回示例



Log

日期 作者 内容
2022/10/19 李世星 修改

直播 live

直播简单列表【应用宣讲会下拉选择】

LIVE_SIMPLE_LIST

获取会议列表

GET: /api/saas/live?name=北斗三号全球

Response Body:

{
  "status": 0,
  "data": [
    {
      "id": 64,
      "name": "集微龙门阵九期—北斗三号全球服务倒计时:北斗全球化视野下的芯片与产业发展",
      "type_id": 2,
      "status": 1,
      "start_time": 1588935600,
      "end_time": 1588946400,
      "active_hour": 3,
      "overview": "集微网第九期“集微龙门阵”将于2020年5月8日(周五)19点以线上论坛形式召开,主题为“北斗三号全球服务倒计时:北斗全球化视野下的芯片与产业发展”,围绕上述热点话题展开线上探讨交流。"
    }
  ]
}

HTTP Method

GET

HTTP Request

/api/saas/live

Request Parameters Query

Parameter Description Type Required Explain
name 直播名称 string 搜索条件

Request Parameters Body

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
id live ID Number
name 直播名称 String
type_id 直播类型 Number
status 状态 Number 1-上架 0-下架
start_time 开始时间 Number
end_time 结束时间 Number
active_hour 活动时长 Number
overview 简介 Number

Log

日期 作者 内容
2022/7/13 李晓东 新增

轮播管理 slideshow

获取轮播管理列表

SLIDESHOW_LIST

获取轮播管理列表

GET: /api/saas/slideshow

Response Body:

{
  "status": 0,
  "current_page": 1,
  "last_page": 1,
  "total": 4,
  "per_page": 10,
  "list": [
    {
      "id": 4,
      "name": "ceshi",
      "target": "APP",
      "location": "首页",
      "type": "外链",
      "link": "www.baidu.com",
      "sort": 4,
      "click_num": 0,
      "status": 0
    },
    {
      "id": 3,
      "name": "MMMEEEFFF",
      "target": "WEB",
      "location": "首页",
      "type": "外链",
      "link": "www.baidu.com",
      "sort": 3,
      "click_num": 0,
      "status": 0
    },
    {
      "id": 2,
      "name": "DDDAAAFFF",
      "target": "小程序",
      "location": "首页",
      "type": "外链",
      "link": "www.baidu.com",
      "sort": 2,
      "click_num": 0,
      "status": 0
    },
    {
      "id": 1,
      "name": "ceshiq",
      "target": "APP",
      "location": "首页",
      "type": "外链",
      "link": "www.baidu.com",
      "sort": 1,
      "click_num": 0,
      "status": 0
    }
  ]
}

HTTP Method

GET

HTTP Request

/api/saas/slideshow

Request Parameters Query

Parameter Description Type Required Explain
name 轮播名称 string 搜索条件
target 投放端 Number 1-APP 2-小程序 3-WEB 4-H5 5-EMP
location 投放位置 Number 1-首页 2-宣讲会 3-双选会 4-小程序广告 5-EMP广告 6-APP职场页
type 轮播类型 Number 1-外链 2-传图片 3-自定义 4-关联双选会 5-关联宣讲会
status 上下架状态 Number 1-上架 0-下架

Request Parameters Body

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
current_page 当前页 Number
last_page 下一页 Number
total 总数 Number
per_page 查询条数 Number
list 返回数据 array

List Object

Title Description Type Tips
id 轮播主键 ID Number
name 轮播名称 String
target 投放端 String
location 投放位置 String
type 轮播类型 String
link 外链 String
sort 排序 Number
click_num 点击数 Number
status 状态 bool true-上架 false-下架

Log

日期 作者 内容
2022/7/13 李晓东 新增

新增轮播管理

SLIDESHOW_STORE

新增轮播管理

POST: /api/saas/slideshow

Response Body:

{
  "status": 0,
  "data": {
    "id": 4,
    "name": "ceshi",
    "target": 1,
    "location": 1,
    "type": 1,
    "cover": "jwImg/6795309f4ab3f9f0.png",
    "sort": 4,
    "link": "www.baidu.com",
    "bind_id": 0,
    "intro": ""
  }
}

HTTP Method

POST

HTTP Request

/api/saas/slideshow

Request Parameters Query

Request Parameters Body

Parameter Description Type Required Explain
name 轮播名称 string
target 投放端 Number
location 轮播位置 Number
type 轮播类型 Number
sort 排序值 Number
cover 封面图 string
link 链接地址 string
bind_id 绑定ID Number
intro 自定义描述 string

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
id 主键ID ID Number
name 轮播名称 string
target 投放端 Number
location 轮播位置 Number
type 轮播类型 Number
sort 排序值 Number
cover 封面图 string
link 链接地址 string
bind_id 绑定ID Number
intro 自定义描述 string

Log

日期 作者 内容
2022/7/13 李晓东 新增

编辑轮播管理

SLIDESHOW_EDIT

编辑轮播管理

PUT: /api/saas/slideshow/1

Response Body:

{
  "status": 0,
  "data": {
    "id": 1,
    "name": "ceshiq",
    "target": 1,
    "location": 1,
    "type": 1,
    "cover": "jwImg/6795309f4ab3f9f0.png",
    "sort": 1,
    "link": "www.baidu.com",
    "bind_id": 0,
    "intro": ""
  }
}

HTTP Method

PUT

HTTP Request

/api/saas/slideshow/{id}

Request Parameters Query

Request Parameters Body

Parameter Description Type Required Explain
name 轮播名称 string
target 投放端 Number
location 轮播位置 Number
type 轮播类型 Number
sort 排序值 Number
cover 封面图 string
link 链接地址 string
bind_id 绑定ID Number
intro 自定义描述 string

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
id 主键ID ID Number
name 轮播名称 string
target 投放端 Number
location 轮播位置 Number
type 轮播类型 Number
sort 排序值 Number
cover 封面图 string
link 链接地址 string
bind_id 绑定ID Number
intro 自定义描述 string

Log

日期 作者 内容
2022/7/13 李晓东 新增

获取某个轮播信息

SLIDESHOW_SHOW

获取某个轮播信息

GET: /api/saas/slideshow/1

Response Body:

{
  "status": 0,
  "data": {
    "id": 1,
    "name": "测试广告广告位",
    "target": 1,
    "location": 4,
    "type": 1,
    "cover": "jwImg/6795309f4ab3f9f0.png",
    "sort": 1,
    "link": "www.baidu.com",
    "bind_id": 0,
    "intro": "",
    "status": 1,
    "click_num": 0,
    "created_at": 1657097507
  }
}

HTTP Method

GET

HTTP Request

/api/saas/slideshow/{id}

Request Parameters Query

Request Parameters Body

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
id 主键ID ID Number
name 轮播名称 string
target 投放端 Number
location 轮播位置 Number
type 轮播类型 Number
sort 排序值 Number
cover 封面图 string
link 链接地址 string
bind_id 绑定ID Number
intro 自定义描述 string
status 状态 Number
click_num 点击数 Number
created_at 创建时间 Number

Log

日期 作者 内容
2022/7/13 李晓东 新增

删除某个轮播信息

SLIDESHOW_DELETE

删除某个轮播信息

DELETE: /api/saas/slideshow/2

Response Body:

{
  "status": 0,
  "data": {
    "id": 2,
    "deleted_at": 1657160450
  }
}

HTTP Method

DELETE

HTTP Request

/api/saas/slideshow/{id}

Request Parameters Query

Request Parameters Body

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
id 主键 ID Number
deleted_at 删除时间 Number

Log

日期 作者 内容
2022/7/13 李晓东 新增

修改轮播关联状态

SLIDESHOW_EDIT_STATUS

修改轮播关联状态

PUT: /api/saas/slideshow/3/status

Response Body:

{
  "status": 0,
  "data": {
    "id": 6,
    "status": true
  }
}

HTTP Method

PUT

HTTP Request

/api/saas/slideshow/{id}/status

Request Parameters Query

Request Parameters Body

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
id CareerTalk ID Number
status 上下架 Bool false-下架 true-上架

Log

日期 作者 内容
2022/7/13 李晓东 新增

获取轮播资源信息

SLIDESHOW_RESOURCE

获取轮播资源信息

GET: /api/saas/slideshow/resource

Response Body:

{
  "status": 0,
  "data": {
    "search": {
      "target": {
        "1": "APP",
        "2": "小程序",
        "3": "WEB",
        "4": "H5",
        "5": "EMP"
      },
      "location": {
        "1": "首页",
        "2": "宣讲会",
        "3": "双选会",
        "4": "小程序广告",
        "5": "EMP广告",
        "6": "APP职场页"
      },
      "type": {
        "1": "外链",
        "2": "纯图片",
        "3": "自定义",
        "4": "关联双选会",
        "5": "关联宣讲会"
      },
      "status": [
        "未上架",
        "已上架"
      ]
    },
    "store": {
      "target": {
        "1": "APP",
        "2": "小程序",
        "3": "WEB",
        "4": "H5",
        "5": "EMP"
      },
      "type": {
        "1": "外链",
        "2": "纯图片",
        "3": "自定义",
        "4": "关联双选会",
        "5": "关联宣讲会"
      },
      "location": {
        "1": {
          "6": "职场页"
        },
        "2": {
          "1": "首页",
          "2": "宣讲会",
          "3": "双选会",
          "4": "小程序广告"
        },
        "3": {
          "1": "首页"
        },
        "4": {
          "1": "首页"
        },
        "5": {
          "5": "EMP广告"
        }
      }
    }
  }
}

HTTP Method

GET

HTTP Request

/api/saas/slideshow/resource

Request Parameters Query

Request Parameters Body

Response Data

Resource Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
Search 搜索对象 Object
store 创建对象 Object

Search Object

Title Description Type Tips
target 投放端 array
location 投放位置 array
type 轮播类型 array
status 上下架状态 array

Store Object

Title Description Type Tips
target 投放端 array
location 投放位置 array
type 轮播类型 array

Log

日期 作者 内容
2022/7/13 李晓东 新增

七牛 qiniu

获取七牛Token

GET_QN_TOKEN

获取七牛Token

GET: /api/qn/token

Response Body:

{
  "status": 0,
  "data": {
    "token": "99vFAJy1wVeXiJdSV2BB-VHqOhgKrdRZydXfUv58:MU_Ukeqtnu2P_PXA0fDsPJES9KA=:eyJzY29wZSI6Imppd2VpLWltYWdlcyIsImRlYWRsaW5lIjoxNjU3ODcwMzkzfQ=="
  }
}

HTTP Method

GET

HTTP Request

/api/qn/token

Request Parameters Query

Request Parameters Body

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
token 七牛上传token Number

Log

日期 作者 内容
2022/7/13 李晓东 新增

获取七牛上传目录

GET_QN_DOCUMENTS

获取七牛上传目录

GET: /api/qn/documents

Response Body:

{
  "status": 0,
  "data": {
    "documents": {
      "image": "jwImg/",
      "video": "jiwei/video/"
    }
  }
}

HTTP Method

GET

HTTP Request

/api/qn/documents

Request Parameters Query

Request Parameters Body

Response Data

Response Object

Title Description Type Tips
status code 0为成功 Number
data 返回数据 Object

Data Object

Title Description Type Tips
documents 上传目录 Number

Log

日期 作者 内容
2022/7/13 李晓东 新增

活动 activity

获取投票活动列表

ACTIVITY_VOTE_LIST

GET: /api/saas/activity/vote/list

Response Body:

{
    "status": 0,
    "current_page": 1,
    "last_page": 1,
    "total": 5,
    "per_page": 10,
    "list": [
        {
            "id": 10,
            "activity_id": 1,
            "oms_company_id": 175,
            "company_name": "360科技服务有限公司",
            "company_short": "360科技",
            "real_num": 0,
            "adjustments_num": 0,
            "total_num": 0
        },
        {
            "id": 16,
            "activity_id": 1,
            "oms_company_id": 172,
            "company_name": "华为科技有限公司",
            "company_short": "华为科技",
            "real_num": 1,
            "adjustments_num": 0,
            "total_num": 1
        }
    ]
}

HTTP Method

GET

HTTP Request

/api/saas/activity/vote/list

Request Parameters Query

Parameter Description Type Required Explain
code 活动标识 string 目前可用包含:BESTEMPLOYER
page 分页 页数 默认 1 int 分页 页数 默认 1
limit int 每页 个数 默认 10
sort Object 排序规则
name string 企业名称模糊搜索

Sort Object

Parameter Description Type Required Explain
field 排序字段 string 目前可用包含:total_num real_num
rule 排序规则 string 目前可用包含:asc desc

默认排序规则为企业增加到活动的时间

Request Parameters Body

Response Data

Response Object

Title Description Type Tips
status code 0为成功 int
current_page 当前页 int
last_page 下一页 int
total 总数 int
per_page 查询条数 int
list 返回数据 Object:list

List Object

Title Description Type Tips
id 活动企业ID int company_id
activity_id 活动ID int
oms_company_id oms企业ID int oms企业ID
company_name 公司名称 string
company_short 公司简称 string
real_num 实际投票数 int
adjustments_num 累计补票数 int
total_num 前台投票数 int

Log

日期 作者 内容
2022/11/10 朱思嘉 新增

获取企业库信息列表

ACTIVITY_VOTE_COMMPANY_LIST

GET: /api/saas/activity/vote/company

Response Body:

{
    "status": 0,
    "current_page": 1,
    "last_page": 57,
    "total": 113,
    "per_page": 2,
    "activity_id": 1,
    "list": [
        {
            "id": 400,
            "name": "爱集微(猎头1)",
            "state": 1,
            "admin_user": {
                "id": 30,
                "name": "朱思嘉"
            }
        },
        {
            "id": 393,
            "name": "YB测试有限公司",
            "state": 0,
            "admin_user": {
                "id": "",
                "name": ""
            }
        }
    ]
}

HTTP Method

Get

HTTP Request

/api/saas/activity/vote/company

Request Parameters Query

Parameter Description Type Required Explain
code 活动标识 string 目前可用包含:BESTEMPLOYER
page 分页 页数 默认 1 int 分页 页数 默认 1
limit int 每页 个数 默认 10
name string 公司名称:模糊搜索

Request Parameters Body

Response Data

Response Object

Title Description Type Tips
status code 0为成功 int
current_page 当前页 int
last_page 下一页 int
total 总数 int
per_page 查询条数 int
list 返回数据 Object:list

List Object

Title Description Type Tips
id 活动企业ID int oms_company_id
name 公司名称 string
state 状态 int
admin_user Object

AdminUser Object

Title Description Type Tips
id 用户ID int 存在则为ID 否则为空字符串
name 用户名称 string

Log

日期 作者 内容
2022/11/11 朱思嘉 新增

新增企业信息到活动

ACTIVITY_VOTE_COMMPANY_ADD

POST: /api/saas/activity/vote/company

Response Body:

{
    "status": 0,
    "list": [
        {
            "id": 154,
            "name": "公司",
            "admin_user": {
                "id": 30,
                "name": "朱思嘉"
            },
            "created_at": 1668131497
        },
        {
            "id": 156,
            "name": "爱上大大123",
            "admin_user": {
                "id": 30,
                "name": "朱思嘉"
            },
            "created_at": 1668131497
        }
    ]
}

HTTP Method

POST

HTTP Request

/api/saas/activity/vote/company

Request Parameters Query

Request Parameters Body

Parameter Description Type Required Explain
company_ids 企业ID string oms_company_id 多个用,拼接
activity_id 活动ID int

Response Data

Response Object

Title Description Type Tips
status code 0为成功 int
list 返回数据 Object:list

List Object

Title Description Type Tips
id OMS企业ID int oms_company_id
name 企业名称 string
admin_user 添加用户信息 Object
created_at 创建时间 int

AdminUser Object

Title Description Type Tips
id 用户ID int
name 用户名称 string

Log

日期 作者 内容
2022/11/11 朱思嘉 新增

移除活动中的相关企业

ACTIVITY_VOTE_COMMPANY_DELETE

DELETE: /api/saas/activity/vote/company

Response Body:

{
    "status": 0,
    "list": [
        {
            "id": 148,
            "name": "公司名称爱罗",
            "admin_user": {
                "id": 30,
                "name": "朱思嘉"
            },
            "created_at": 1668131164
        },
        {
            "id": 149,
            "name": "公司名称11111",
            "admin_user": {
                "id": 30,
                "name": "朱思嘉"
            },
            "created_at": 1668131018
        }
    ]
}

HTTP Method

DELETE

HTTP Request

/api/saas/activity/vote/company

Request Parameters Query

Request Parameters Body

Parameter Description Type Required Explain
company_ids 企业ID string oms_company_id 多个用,拼接
activity_id 活动ID int

Response Data

Response Object

Title Description Type Tips
status code 0为成功 int
list 返回数据 Object:list

List Object

Title Description Type Tips
id OMS企业ID int oms_company_id
name 企业名称 string
admin_user 添加用户信息 Object
created_at 创建时间 int

AdminUser Object

Title Description Type Tips
id 用户ID int
name 用户名称 string

Log

日期 作者 内容
2022/11/11 朱思嘉 新增

补充某个企业的票数

ACTIVITY_VOTE_COMMPANY_PUT

PUT: /api/saas/activity/vote/company

Response Body:

{
    "status": 0,
    "data": {
        "id": 25
    }
}

HTTP Method

PUT

HTTP Request

/api/saas/activity/vote/company

Request Parameters Query

Request Parameters Body

Parameter Description Type Required Explain
company_id 企业ID string company_id 为获取投票活动列表中的company_id并不是oms_company_id
activity_id 活动ID int
num 票数 int

Response Data

Response Object

Title Description Type Tips
status code 0为成功 int
data 返回数据 Object

Data Object

Title Description Type Tips
id 活动企业ID int company_id

Log

日期 作者 内容
2022/11/11 朱思嘉 新增

文档使用帮助

index.html.md文件中进行编辑目录和文档总体结构,然后在includes目录中添加对应的模块。

文档使用Markdown语言排版。

Markdown格式示例


# 标题
## 二级标题
### .......

​``` json
代码块
​```

表格
表头 | 表头 
---------- | -------
内容 | 内容 
内容 | 内容 

`Something`

表格

表头 表头
内容 内容
内容 内容

Json 是没有注释的 避免在json中写注释

Something 高亮

加粗 粗体

横线

下划线

斜体

链接

图片

示例API接口

The above command returns JSON structured like this:

{
  "id": 2,
  "name": "Max",
  "breed": "unknown",
  "fluffiness": 5,
  "cuteness": 10
}

This endpoint retrieves a specific kitten.

HTTP Request

GET http://example.com/kittens/<ID>

URL Parameters

Parameter Description
ID The ID of the kitten to retrieve