agent-foundation/docs/xuebang-get-api-catalog.md
2026-09-23 10:15:56 +08:00

10 KiB
Raw Permalink Blame History

学邦 GET 接口目录

operationId 分类 接口说明 路径 必填参数 可分页 状态
findByInstitutionUsingGET 07-合同流水 06-获取扣费记录 /api/accountChargeRecords/findByInstitution 无 是 可查询
getUsingGET_1 001-回调接口 02-获取回调信息 /api/callback/ 无 否 可查询
findByInstitutionUsingGET_4 07-合同流水 01-获取合同记录 /api/contract/findByInstitution 无 是 可查询
refundWorkFlowDetailUsingGET 07-合同流水 02-获取合同退费审批流程详情 /api/contract/refundWorkFlow processInstanceId 否 可查询
findByInstitutionUsingGET_3 07-合同流水 05-获取业绩分配记录 /api/contractBonusBonus/findByInstitution 无 是 可查询
findByInstitutionUsingGET_5 07-合同流水 02-获取已报课程记录 /api/contractProduct/findByInstitution 无 是 可查询
pageUsingGET_1 08-一对一管理 03-获取1对1试听记录 /api/courseAudition/page 无 是 可查询
findByInstitutionUsingGET_1 05-客户管理 06-分页查询机构上门记录 /api/customer/appiontmentManage/findByInstitution 无 是 可查询
findByInstitutionUsingGET_2 05-客户管理 08-分页查询机构试听记录信息 /api/customer/auditionOrder/findByInstitution 无 是 可查询
findByInstitutionUsingGET_6 05-客户管理 05-分页查询机构客户跟进记录 /api/customer/customerFollowup/findByInstitution 无 是 可查询
findByInstitutionUsingGET_7 05-客户管理 07-分页查询机构客户转介绍信息 /api/customer/customerNewIntroduce/findByInstitution 无 是 可查询
findCustomerListUsingGET 05-客户管理 03-分页查询客户 /api/customer/findCustomerList 无 是 可查询
findCustomerTagUsingGET 05-客户管理 03-分页查询客户标签 /api/customerTag/findCustomerTag 无 是 可查询
listUsingGET_2 12-其他 获取所有电子账户 /api/electronicAccountModel/list 无 否 可查询
pageUsingGET 财务系统专用 扣费资金流水 /api/financeLog/accountChargeRecordsDetail/page 无 是 可查询
pageUsingGET_2 财务系统专用 账户资金流水 /api/financeLog/electronicAccountChangeLog/page 无 是 可查询
pageUsingGET_3 财务系统专用 收款资金流水 /api/financeLog/moneyArrangeLogDetails/page 无 是 可查询
pageUsingGET_6 财务系统专用 转课流水 /api/financeLog/studentChangeLessonRefFinance/page 无 是 可查询
pageUsingGET_9 财务系统专用 退费资金流水 /api/financeLog/studentReturnFeeLog/page 无 是 可查询
findByInstitutionUsingGET_8 07-合同流水 03-获取收款记录 /api/fundsChangeHistory/findByInstitution 无 是 可查询
findByInstitutionUsingGET_9 校长收银 分页查询校长收银 /api/huifuCommonFundsRecord/page 无 是 可查询
findPageUsingGET_4 09-班课管理 05-获取班课学员考勤记录 /api/miniClass/attendance/page 无 是 可查询
findPageUsingGET 09-班课管理 07-获取教室列表 /api/miniClass/classroomManage/page 无 是 可查询
findContentPageUsingGET 09-班课管理 08-获取班课上课内容 /api/miniClass/course/contents miniClassCourseIds 是 可查询
findPageUsingGET_2 09-班课管理 04-获取班课排课记录 /api/miniClass/course/page 无 是 可查询
findPageUsingGET_3 09-班课管理 06-获取档期列表 /api/miniClass/miniClassScheduleManagement/page 无 是 可查询
findPageUsingGET_5 09-班课管理 02-获取班课学员产品列表 /api/miniClass/miniClassStudentContractProduct/page 无 是 可查询
findPageUsingGET_1 09-班课管理 01-获取班课记录 /api/miniClass/page 无 是 可查询
findListUsingGET 09-班课管理 03-获取班课学员列表 /api/miniClass/student/list 无 是 可查询
getArrangeCourseStatisticsUsingGET 09-班课管理 01-获取排课统计数据 /api/miniClass/user/getArrangeCourseStatistics 无 否 可查询
findByInstitutionUsingGET_10 07-合同流水 04-获取资金分配记录 /api/moneyArrangeLog/findByInstitution 无 是 可查询
findByInstitutionUsingGET_11 10-一对N管理 03-获取1对N学员考勤记录 /api/oneOnN/attendance/findByInstitution 无 是 可查询
findByInstitutionUsingGET_12 10-一对N管理 02-获取1对N排课记录 /api/oneOnN/course/findByInstitution 无 是 可查询
findByInstitutionUsingGET_13 10-一对N管理 01-获取小组列表 /api/oneOnN/group/findByInstitution 无 是 可查询
findPageByInstitutionUsingGET 08-一对一管理 01-获取1对1排课记录 /api/oneOnOne/course/findPageByInstitution 无 是 可查询
pageUsingGET_4 在线商城 渠道订单查询 /api/onlineorderproduct/OnlineOrderProductController/page cusOrgId、resTypeId 是 可查询
pageUsingGET_5 在线商城 校区商品列表 /api/onlineproduct/OnlineProductCampusDetailController/page 无 是 可查询
getPromotionCouponDetailPageUsingGET 在线商城 02-优惠券明细查询 /api/onlinewxappmall/promotionCoupon/getPromotionCouponDetailPage 无 是 可查询
getPromotionCouponPageUsingGET 在线商城 01-优惠券查询 /api/onlinewxappmall/promotionCoupon/getPromotionCouponPage 无 是 可查询
pageUsingGET_8 在线商城 渠道学员查询 /api/onlinewxappmall/student/page cusOrgId、resTypeId 是 可查询
searchUsingGET 02-组织架构管理 获取组织架构信息列表 /api/org/composite/search ids、type 是 可查询
findListByInstitutionUsingGET 02-组织架构管理 01-获取组织架构信息 /api/org/listByInstitution 无 是 可查询
findOpenOnlineOrgByInstitutionUsingGET 02-组织架构管理 02-线上商城校区信息查询 /api/org/openOnlineOrgByInstitution 无 是 可查询
getHourNotEnoughStudentUsingGET 12-其他 02-获取课时不足学员数 /api/others/totalData/getHourNotEnoughStudent 无 否 可查询
getPendingDoUsingGET 12-其他 01-获取今日待办数据 /api/others/totalData/getPendingDo 无 否 可查询
listForRefundUsingGET 12-其他 退款用支付方式 /api/payWayConfig/listForRefund 无 否 可查询
getProductsByInstitutionUsingGET 04-产品管理 01-获取产品列表 /api/product/getProductsByInstitution 无 是 可查询
listProductsUsingGET 04-产品管理 获取课程信息 /api/product/listProducts ids 否 可查询
getProductOutlinesByInstitutionUsingGET 04-产品管理 02-获取课程大纲列表 /api/product/outlines productIds 是 可查询
findListByInstitutionUsingGET_1 03-人事管理 01-获取职位列表 /api/role/findListByInstitution 无 是 可查询
findStudentIntegralLogUsingGET 06-学员管理 05-学员积分查询 /api/student/findStudentIntegralLog 无 是 可查询
findStudentOrganizationLogUsingGET 06-学员管理 07-学员跨校区记录查询 /api/student/findStudentOrganizationLog 无 是 可查询
findStudentsByInstitutionUsingGET 06-学员管理 01-获取机构学员列表 /api/student/findStudentsByInstitution 无 是 可查询
findTransactionCampusUsingGET 06-学员管理 06-学员转校区记录查询 /api/student/findTransactionCampus 无 是 可查询
getStudentClassReportStatisticsUsingGET 06-学员管理 07-课堂报告统计数据 /api/student/studentComment/getStudentClassReportStatistics 无 否 可查询
pageUsingGET_7 06-学员管理 02-分页获取学员课堂报告记录 /api/student/studentComment/page 无 是 可查询
wxappMarketingActivityRefStudentInfoDetailsUsingGET 06-学员管理 09-获取报名表单报名记录 /api/student/wxappMarketingActivityRefStudentInfoDetails wxappMarketingActivityRefStudentInfoId 是 可查询
findByInstitutionUsingGET_14 07-合同流水 08-退费支出单 /api/studentReturnExpenditureReceipt/findByInstitution 无 是 可查询
findByInstitutionUsingGET_15 07-合同流水 07-退费记录 /api/studentReturnFee/findByInstitution 无 是 可查询
listUsingGET 01-基础参数 02-获取自定义属性列表 /api/sys/customize/field/properties 无 是 可查询
listUsingGET_1 01-基础参数 03-获取自定义字段列表 /api/sys/customize/field/values businessIds、category 是 可查询
listByInstitutionUsingGET 01-基础参数 01-获取基础参数列表 /api/sys/datadicts/listByInstitution 无 是 可查询
findTagConfigListUsingGET 05-客户管理 04-查询标签组列表 /api/tagconfig/findTagConfigList tagConfigType 否 可查询
searchUsingGET_1 03-人事管理 获取员工信息列表 /api/user/composite/search ids、type 是 可查询
findUserForLoginUsingGET 03-人事管理 03-用户登录验证 /api/user/findUserForLogin contact、password 否 后端专用:登录密码不得通过通用查询接口传输
findListByInstitutionUsingGET_2 03-人事管理 02-获取员工及老师列表 /api/user/listByInstitution 无 是 可查询
getStudentTokenUsingGET 11-微信小程序 01-获取学生token /api/wxapp/getStudentToken studentId 否 后端专用:学生 Token 属于敏感凭证
getUsingGET 00-AccessToken管理 获取AccessToken /token/{clientId} clientId 否 后端专用:AccessToken 由后端鉴权组件管理

完整参数定义以 src/main/resources/xuebang-get-api-catalog.json 为准。