成员

获取单个成员数据

可以获取单个成员的信息，当前影响力及总积分

接口调用说明：

GET https://lxapi.lexiangla.com/cgi-bin/v1/staffs/{staff_id}?fields[staff]=influence,point_total

参数说明：

参数	是否必须	默认值	说明
staff_id	是	无	员工帐号,对应管理端的帐号，企业内必须唯一。
fields[staff]	否	默认influence,point_total	fields参数的值必须用逗号分隔开，目前仅支持influence,point_total

响应document

200 OK 状态码

{
    "data": {
        "type": "staff",
        "id": "LX007",
        "attributes": {
            "name": "树苗",
            "english_name": "zhangsan",
            "organization": "产品部",
            "influence": 760,
            "point_total": 435
        }
    },
    "links": {
        "self": "https://lxapi.lexiangla.com/cgi-bin/v1/staffs/LX007"
    }
}

参数说明：

参数	说明
staff.type	资源对象类型，必须为 staff，表示成员
staff.id	员工帐号
staff.name	成员名
staff.english_name	成员英文名
staff.organization	成员所属部门
staff.influence	影响力
staff.point_total	总积分

获取单个成员待办数据

可以获取单个成员的检视待办、反馈待办和待我审批的数量统计

接口调用说明：

GET http://lxapi.lexiangla.com/cgi-bin/v1/staffs/{staff_id}/todo-data

参数说明：

参数	是否必须	默认值	说明
staff_id	是	无	员工帐号,对应管理端的帐号，企业内必须唯一。

响应document

200 OK 状态码

{
    "data": {
        "type": "staff",
        "id": "XXXX",
        "attributes": {
            "feedback_count": 88,
            "doc_inspection_count": 111,
            "workflow_count": 106
        }
    }
}

参数说明：

参数	说明
type	员工类型
id	员工id
attributes.feedback_count	反馈待办数
attributes.doc_inspection_count	检视待办数
attributes.workflow_count	待审批数

获取指定成员权限可见的数据列表

接口调用说明：

GET http://lxapi.lexiangla.com/cgi-bin/v1/staffs/{staff_id}/app-data?module_type=clazz&ids=xxx,xxx,...

参数说明：

参数	是否必须	默认值	说明
staff_id	是	无	员工帐号,对应管理端的帐号，企业内必须唯一。
module_type	是	无	应用类型，支持：clazz live roadmap clazz表示课程 live表示直播 roadmap表示项目
per_page	否	20	每页数，支持1~500之间所有整数
page_token	否	无	下一页token，请求第一页时无需传参
ids	否	无	应用内容ID，支持课堂/直播ID，支持传入多个内容ID，不支持分页

当module_type=clazz响应document

200 OK 状态码

{
    "data": [
        {
            "type": "clazz",
            "id": "1cd708447e4111ef9c94a2760b7307dd",
            "attributes": {
                "title": "课程1",
                "cover_img": "",
                "course_count": 2,
                "created_at": "2024-09-29 16:59:19",
                "is_shelved": false,
                "participants_count": 1,
                "app_source_type": "clazz"
            },
            "links": {
                "platform": "https://km.lexiangla.com/classes/1cd708447e4111ef9c94a2760b7307dd?type=",
                "manager": "https://km.lexiangla.com/classes/1cd708447e4111ef9c94a2760b7307dd/settings?type="
            }
        },
        {
            "type": "clazz",
            "id": "ff09583a7e3611efb8538e9294422ec7",
            "attributes": {
                "title": "课程2",
                "cover_img": "https://km.lexiangla.com/assets/f07ea2c07e3611efb9288e9294422ec7",
                "course_count": 6,
                "created_at": "2024-09-29 15:46:54",
                "is_shelved": true,
                "participants_count": 7,
                "app_source_type": "clazz"
            },
            "links": {
                "platform": "https://km.lexiangla.com/teams/k101683/classes/ff09583a7e3611efb8538e9294422ec7?type=",
                "manager": "https://km.lexiangla.com/teams/k101683/classes/ff09583a7e3611efb8538e9294422ec7/settings?type="
            }
        }
    ],
    "meta": {
        "page_token": "eyJsYXN0X2luY3JfaWQiOjI5OTQyfQ"
    }
}

参数说明：

参数	说明
data.attributes.title	开课主题
data.attributes.cover_img	课程封面
data.attributes.course_count	子课程数
data.attributes.created_at	创建时间
data.attributes.is_shelved	是否为上架状态，1：已上架 0：未上架
data.attributes.participants_count	已学人数
data.attributes.app_source_type	应用来源：clazz，课堂；roadmap，项目
data.links.platform	课程详情页链接
data.links.manager	课堂管理页链接

当module_type=live响应document

200 OK 状态码

{
    "data": [
        {
            "type": "live",
            "id": "f0feb9ea87ac11efb093f6553e515b2f",
            "attributes": {
                "title": "直播",
                "intro": "",
                "status": "init",
                "pic": "",
                "visit_count": 1,
                "subscribe_count": 0,
                "video_duration": 0,
                "started_at": "2024-10-11 16:43:00",
                "created_at": "2024-10-11 16:43:51",
                "is_subscribed": false
            },
            "links": {
                "platform": "https://km.lexiangla.com/teams/k101145/lives/f0feb9ea87ac11efb093f6553e515b2f",
                "manager": "https://km.lexiangla.com/teams/k101145/lives/f0feb9ea87ac11efb093f6553e515b2f/settings",
                "open": ""
            }
        },
        {
            "type": "live",
            "id": "5b2f315287ab11efb497b21b22f67cc0",
            "attributes": {
                "title": "直播2024-10-11 16:32",
                "intro": "",
                "status": "init",
                "pic": "",
                "visit_count": 0,
                "subscribe_count": 0,
                "video_duration": 0,
                "started_at": "2024-10-11 16:32:00",
                "created_at": "2024-10-11 16:32:31",
                "is_subscribed": false
            },
            "links": {
                "platform": "https://km.lexiangla.com/lives/5b2f315287ab11efb497b21b22f67cc0",
                "manager": "https://km.lexiangla.com/lives/5b2f315287ab11efb497b21b22f67cc0/settings",
                "open": ""
            }
        }
    ],
    "meta": {
        "page_token": "eyJsYXN0X2luY3JfaWQiOjIzMTc3fQ"
    }
}

参数说明：

参数	说明
data.attributes.title	直播的标题
data.attributes.intro	直播简介
data.attributes.status	直播的状态（init：初始化, waiting：等待, pushing：推流状态, finished：完成）
data.attributes.pic	直播封面图
data.attributes.visit_count	直播总观看次数
data.attributes.subscribe_count	直播的预约人数
data.attributes.video_duration	直播时长
data.attributes.started_at	直播的开始时间
data.attributes.created_at	直播的创建时间
data.attributes.is_subscribed	是否预约
data.links.platform	直播详情页链接
data.links.manager	直播管理页链接

当module_type=roadmap响应document

200 OK 状态码

{
    "data": [
        {
            "type": "roadmap",
            "id": "6903",
            "attributes": {
                "title": "k吧-学习地图",
                "cover": "",
                "checkpoint_count": 1,
                "created_at": "2024-10-16 14:21:02",
                "subject_type": "learning",
                "status": 1,
                "to_staff_count": 189
            },
            "links": {
                "platform": "https://km.lexiangla.com/teams/k101718/learning/6903/list"
            },
            "relationships": {
                "team": {
                    "data": {
                        "type": "team",
                        "id": "4ead32948b6611efa28fa6f48fdb896a"
                    }
                }
            }
        },
        {
            "type": "roadmap",
            "id": "4894",
            "attributes": {
                "title": "k吧-培训-01",
                "cover": "",
                "checkpoint_count": 52,
                "created_at": "2023-12-27 16:05:34",
                "subject_type": "training",
                "status": 1,
                "to_staff_count": 189
            },
            "links": {
                "platform": "https://km.lexiangla.com/learning/4894/list"
            }
        }
    ],
    "included": [
        {
            "type": "team",
            "id": "4ead32948b6611efa28fa6f48fdb896a",
            "attributes": {
                "code": "k101718",
                "name": "K吧",
                "type": 1,
                "logo": "//static.lexiang-asset.com/build/img/default@2x-42e4b0a8.png",
                "signature": "测试k吧",
                "is_secret": 0,
                "application": [
                    "knowledge",
                    "event",
                    "album",
                    "survey",
                    "exam",
                    "course",
                    "liveroom",
                    "share",
                    "roadmap",
                    "collection"
                ]
            },
            "links": {
                "platform": "https://km.lexiangla.com/teams/k101718"
            }
        }
    ],
    "meta": {
        "page_token": "eyJsYXN0X2luY3JfaWQiOjQwNDk0MzkzfQ"
    }
}

参数说明：

参数	说明
data.attributes.title	项目主题
data.attributes.cover	封面
data.attributes.checkpoint_count	任务数
data.attributes.created_at	创建时间
data.attributes.status	项目状态；1：进行中，2：已结项
data.attributes.subject_type	类型：learning（学习地图），training（培训班）
data.attributes.to_staff_count	应完成人数
data.links.platform	项目详情页链接

获取单个成员学习整体数据

接口调用说明：

GET https://lxapi.lexiangla.com/cgi-bin/v1/staffs/{staff_id}/training-profile

参数说明：

参数	是否必须	默认值	说明
staff_id	是	无	员工帐号,对应管理端的帐号，企业内必须唯一。

响应document

200 OK 状态码

{
    "data": {
        "type": "staff",
        "id": "zhangsan",
        "attributes": {
            "exam_count": 32,
            "clazz_count": 17,
            "roadmap_count": 7,
            "certificate_count": 2,
            "learn_time": "2.3",
            "credit_total": 0
        }
    },
    "links": {
        "self": "https://lxapi.lexiangla.net/cgi-bin/v1/staffs/zhangsan/training-profile"
    }
}

参数说明：

参数	说明
data.attributes.exam_count	已完成考试数
data.attributes.clazz_count	已完成课程数
data.attributes.roadmap_count	已完成项目数
data.attributes.certificate_count	已获得证书数
data.attributes.learn_time	课程学习时长
data.attributes.credit_total	已获得学分