ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

Entity

该模块用于基础信息，供开发者使用

API	Description
GET entity/get_nation_list	国家(地区)码列表
GET entity/download_from	No documentation available.
GET entity/user_status	No documentation available.
GET entity/block_keyword	No documentation available.
GET entity/user_type	No documentation available.
GET entity/error_code	No documentation available.
GET entity/regions	No documentation available.
GET entity/cities_and_regions	No documentation available.
GET entity/province_cities_and_regions	No documentation available.
GET entity/province_and_cities	No documentation available.
GET entity/enabled_cities	No documentation available.
GET entity/open_cities	No documentation available.
GET entity/provinces	No documentation available.
GET entity/cities_by_province/{id}	No documentation available.
GET entity/regions_by_city/{id}	No documentation available.
GET entity/all_parent_regions?region_ids={region_ids}	No documentation available.
GET entity/all_child_regions?region_ids={region_ids}	No documentation available.
GET entity/is_open_region?region_id={region_id}	No documentation available.
GET entity/is_enabled_region?region_id={region_id}	No documentation available.
GET entity/region_type	No documentation available.
GET entity/wechat_type	No documentation available.
GET entity/code_type	No documentation available.
GET entity/constellation	No documentation available.
GET entity/zodiac	No documentation available.
GET entity/device	No documentation available.
GET entity/device_type	No documentation available.
GET entity/verify_type	No documentation available.
GET entity/versions?app_id={app_id}	No documentation available.

Promotion

API	Description
POST promotion/add_coupon	No documentation available.
GET promotion/get_coupon_anonymous?user_id={user_id}&client_id={client_id}&shop_id={shop_id}&shop_ids={shop_ids}&coupon_type_id={coupon_type_id}&coupon_id={coupon_id}&category_id={category_id}&coupon_group_id={coupon_group_id}&format={format}&hide_used={hide_used}&membership={membership}&from_type_id={from_type_id}&page_index={page_index}&page_size={page_size}	No documentation available.
GET promotion/get_coupon?client_id={client_id}&shop_id={shop_id}&shop_ids={shop_ids}&coupon_type_id={coupon_type_id}&coupon_id={coupon_id}&category_id={category_id}&coupon_group_id={coupon_group_id}&format={format}&hide_used={hide_used}&membership={membership}&from_type_id={from_type_id}&page_index={page_index}&page_size={page_size}	No documentation available.
POST promotion/add_user_coupon	No documentation available.
GET promotion/get_user_coupon?user_coupon_id={user_coupon_id}&user_coupon_ids={user_coupon_ids}&baseline={baseline}&shop_id={shop_id}&promotion_status_id={promotion_status_id}&category_id={category_id}&category_ids={category_ids}&categories_json={categories_json}&format={format}	No documentation available.
GET promotion/get_user_coupon_detail?user_coupon_id={user_coupon_id}&path={path}&format={format}&client_id={client_id}&app_id={app_id}&oss={oss}	No documentation available.
GET promotion/get_user_coupon_paging?user_coupon_id={user_coupon_id}&baseline={baseline}&client_id={client_id}&shop_id={shop_id}&promotion_status_id={promotion_status_id}&category_id={category_id}&category_ids={category_ids}&categories_json={categories_json}&format={format}&page_index={page_index}&page_size={page_size}	No documentation available.
PATCH promotion/use_user_coupon/{ids}	No documentation available.
PATCH promotion/use_user_coupon	No documentation available.
POST promotion/shop_use_user_coupon	No documentation available.
GET promotion/get_shop_coupon?client_id={client_id}&shop_id={shop_id}&coupon_status_id={coupon_status_id}&format={format}&page_index={page_index}&page_size={page_size}	No documentation available.
DELETE promotion/delete_shop_coupon	No documentation available.
GET promotion/get_user_coupon_used_record?user_id={user_id}&shop_id={shop_id}&begin_date={begin_date}&end_date={end_date}&format={format}&client_id={client_id}&page_index={page_index}&page_size={page_size}	No documentation available.
GET promotion/get_best_user_coupon?client_id={client_id}&baseline={baseline}	No documentation available.
POST promotion/apply_distribution_user	No documentation available.
GET promotion/get_distribution_user_info?client_id={client_id}	No documentation available.
GET promotion/get_distribution_user_fans?client_id={client_id}&begin_date={begin_date}&end_date={end_date}&page_index={page_index}&page_size={page_size}	No documentation available.
GET promotion/get_child_distribution_users?client_id={client_id}&page_index={page_index}&page_size={page_size}	No documentation available.
GET promotion/get_distribution_user_spent_record?client_id={client_id}&page_index={page_index}&page_size={page_size}	No documentation available.
GET promotion/get_distribution_invitation_config?client_id={client_id}	No documentation available.
GET promotion/get_distribution_user_cash_flow_list?client_id={client_id}&begin_date={begin_date}&end_date={end_date}&page_index={page_index}&page_size={page_size}	No documentation available.
GET promotion/get_distribution_user_income?client_id={client_id}	No documentation available.
GET promotion/get_distribution_income_share_image?client_id={client_id}&app_id={app_id}&share_user_id={share_user_id}&is_oss={is_oss}	No documentation available.
GET promotion/get_distribution_user_performance_list?client_id={client_id}&begin_date={begin_date}&end_date={end_date}&page_index={page_index}&page_size={page_size}	No documentation available.
POST promotion/add_or_update_lottery	No documentation available.
POST promotion/upate_winner_address	No documentation available.
POST promotion/lottery_report	No documentation available.
POST promotion/update_wechat_qr_code	No documentation available.
GET promotion/lottery_subscribed?client_id={client_id}	No documentation available.
GET promotion/get_my_join_not_opened_lottery_list	No documentation available.
GET promotion/get_my_join_opened_lottery_list?page_index={page_index}&page_size={page_size}	No documentation available.
GET promotion/get_my_post_not_opened_lottery_list	No documentation available.
GET promotion/get_my_post_opened_lottery_list?page_index={page_index}&page_size={page_size}	No documentation available.
GET promotion/get_my_win_lottery_list?page_index={page_index}&page_size={page_size}	No documentation available.
GET promotion/get_lottery_home_list?lottery_status_id={lottery_status_id}&advanced={advanced}&my_lottery={my_lottery}&home_page_listing={home_page_listing}&lottery_name={lottery_name}&sponsor_id={sponsor_id}&sponsor_name={sponsor_name}&open_type_id={open_type_id}&client_id={client_id}&shop_id={shop_id}&user_id={user_id}&page_index={page_index}&page_size={page_size}	No documentation available.
GET promotion/get_lottery_list?lottery_status_id={lottery_status_id}&advanced={advanced}&my_lottery={my_lottery}&home_page_listing={home_page_listing}&lottery_name={lottery_name}&sponsor_id={sponsor_id}&sponsor_name={sponsor_name}&open_type_id={open_type_id}&client_id={client_id}&shop_id={shop_id}&user_id={user_id}&page_index={page_index}&page_size={page_size}	No documentation available.
GET promotion/get_lottery_detail_and_update_view_count?lottery_id={lottery_id}&share_user_id={share_user_id}&join_group_id={join_group_id}&path={path}&user_name={user_name}&head_image_path={head_image_path}&app_key={app_key}&is_from_official={is_from_official}	No documentation available.
GET promotion/get_open_type	No documentation available.
GET promotion/get_my_lottery_list?lottery_status_id={lottery_status_id}&advanced={advanced}&my_lottery={my_lottery}&home_page_listing={home_page_listing}&lottery_name={lottery_name}&sponsor_id={sponsor_id}&sponsor_name={sponsor_name}&open_type_id={open_type_id}&client_id={client_id}&shop_id={shop_id}&user_id={user_id}&page_index={page_index}&page_size={page_size}	No documentation available.
GET promotion/get_my_lottery_data?client_id={client_id}&shop_id={shop_id}	No documentation available.
POST promotion/join_lottery	No documentation available.
GET promotion/get_join_lottery_list?client_id={client_id}&lottery_id={lottery_id}&last_join_id={last_join_id}&joiner_id={joiner_id}&page_index={page_index}&page_size={page_size}	No documentation available.
GET promotion/get_join_lottery_group_list?client_id={client_id}&lottery_id={lottery_id}&last_join_id={last_join_id}&joiner_id={joiner_id}&page_index={page_index}&page_size={page_size}	No documentation available.
GET promotion/get_lottery_winner_list?client_id={client_id}&lottery_id={lottery_id}&lottery_user_id={lottery_user_id}&page_index={page_index}&page_size={page_size}	No documentation available.
GET promotion/get_my_lottery_winner_list?client_id={client_id}&lottery_id={lottery_id}&lottery_user_id={lottery_user_id}&page_index={page_index}&page_size={page_size}	No documentation available.
POST promotion/open_lottery_manually/{id}	No documentation available.
POST promotion/receive_lottery	No documentation available.
GET promotion/get_lottery_qr_code_image?lottery_id={lottery_id}&share_user_id={share_user_id}&join_group_id={join_group_id}&path={path}&user_name={user_name}&head_image_path={head_image_path}&app_key={app_key}&is_from_official={is_from_official}	No documentation available.
GET promotion/get_lottery_row_image?lottery_id={lottery_id}&share_user_id={share_user_id}&join_group_id={join_group_id}&path={path}&user_name={user_name}&head_image_path={head_image_path}&app_key={app_key}&is_from_official={is_from_official}	No documentation available.
GET promotion/get_lottery_share_image?lottery_id={lottery_id}&share_user_id={share_user_id}&join_group_id={join_group_id}&path={path}&user_name={user_name}&head_image_path={head_image_path}&app_key={app_key}&is_from_official={is_from_official}	No documentation available.
GET promotion/get_win_share_image?lottery_id={lottery_id}&share_user_id={share_user_id}&join_group_id={join_group_id}&path={path}&user_name={user_name}&head_image_path={head_image_path}&app_key={app_key}&is_from_official={is_from_official}	No documentation available.
GET promotion/get_big_turntable_info?client_id={client_id}	No documentation available.
GET promotion/get_user_win_lottery_list?client_id={client_id}&lottery_type_id={lottery_type_id}&page_index={page_index}&page_size={page_size}	No documentation available.
POST promotion/join_big_turntable	No documentation available.
GET promotion/get_membership_card_list?client_id={client_id}	No documentation available.
POST promotion/open_membership	No documentation available.
GET promotion/get_membership_topup_config_list?card_id={card_id}&client_id={client_id}	No documentation available.
POST promotion/topup_membership	No documentation available.
POST promotion/user_defined_topup_membership	No documentation available.
POST promotion/renewal_membership	No documentation available.
GET promotion/get_membership_user_right?client_id={client_id}	No documentation available.
GET promotion/get_membership_card_user?client_id={client_id}	No documentation available.
POST promotion/sign_in	No documentation available.
GET promotion/get_user_point_record?point_type_id={point_type_id}&point_type_ids={point_type_ids}&wechat_share_type_id={wechat_share_type_id}&order_id={order_id}&page_index={page_index}&page_size={page_size}	No documentation available.
POST promotion/click_share_link	No documentation available.

Account

该模块用于注册登录

API	Description
POST account/login	app登录
POST account/register	app注册
POST account/wxa_login	小程序登录
POST account/wxa_register	小程序注册
POST account/reset_password	No documentation available.
POST account/change_password	No documentation available.
GET account/verify_token	No documentation available.
POST account/get_mobile_code	No documentation available.
POST account/get_email_code	No documentation available.
POST account/get_free_mobile_code	No documentation available.
POST account/verify_mobile_code	No documentation available.
POST account/bind_third_party	No documentation available.
POST account/unbind_third_party	No documentation available.
POST account/replace_password	No documentation available.

Course

API	Description
GET course/get_user_course_list?course_type_id={course_type_id}&page_index={page_index}&page_size={page_size}	获取我的课程
GET course/get_course_details?course_id={course_id}&user_id={user_id}	获取课程详情
GET course/get_class_video_list/{class_id}	获取录播视频列表
GET course/get_course_collect_list?course_type_id={course_type_id}&page_index={page_index}&page_size={page_size}	获取我的收藏
GET course/get_course_leave_list/{id}	待请假(传入ID)获取当前id 的课程的可以请假的课时
POST course/post_course_leave_reason	申请请假(传入ID)
GET course/get_course_change/{id}	1、调课(获得ID)，与请假共用一个方法，获取当前课程余下的所有支持换的课时，传当前课程id
GET course/get_course_wait_change/{id}	2、调至其他课程，显示同年级的所有课程列表，传当前课程id
GET course/get_class_wait_change/{id}	3、调至其他课时，显示调至课程的所有余下课时列表，传调至课程的课程id
POST course/post_change_class	提交调课申请
GET course/get_course_search_page?title={title}&course_type_id={course_type_id}&grade_id={grade_id}&user_id={user_id}&subject_id={subject_id}&page_index={page_index}&page_size={page_size}	获取搜索课程
GET course/get_course_outline?course_id={course_id}&user_id={user_id}	课程大纲接口
GET course/buy_course/{course_id}	购买课程
GET course/collect_course/{course_id}	收藏课程

File

该模块用于文件上传下载

API	Description
POST file/upload_image	No documentation available.
POST file/upload_images	No documentation available.
POST file/upload_oss	No documentation available.
POST file/upload_oss_anonymous	No documentation available.
GET file/get_oss_upload_param?file_name={file_name}	No documentation available.
GET file/get_oss_token	No documentation available.
GET file/get_anonymous_oss_token	No documentation available.
POST api/File	No documentation available.

该模块用于基础信息，供开发者使用

API	Description
GET banner/type?shop_id={shop_id}	No documentation available.
GET banner/position?shop_id={shop_id}	No documentation available.
GET banner/list?device_type_id={device_type_id}&position_id={position_id}&position_name={position_name}&city_id={city_id}&shop_id={shop_id}&group_id={group_id}	No documentation available.
GET banner/cache_list?position_id={position_id}&position_ids={position_ids}&group_id={group_id}&shop_id={shop_id}&client_id={client_id}	No documentation available.
GET banner/detail/{id}	No documentation available.
GET banner/api_get_banner_launch_list?banner_id={banner_id}&city_id={city_id}&shop_id={shop_id}	No documentation available.

User

该模块用于用户

API	Description
POST user/edit_mobile	更改手机号
GET user/get_user_detail	展示用户基本资料
POST user/edit_user_detail	编辑用户基本资料
GET user/get_mine	展示我的界面

Payment

API	Description
POST payment/trade_third_party	No documentation available.
GET payment/balance	No documentation available.
POST payment/pay	支付订单（测试支付接口，正式环境弃用）
GET payment/get_bill_list?client_id={client_id}&shop_id={shop_id}&page_index={page_index}&page_size={page_size}	No documentation available.
POST payment/cash_out	No documentation available.
GET payment/cash_flow?trade_type_id={trade_type_id}&trade_type_ids={trade_type_ids}&year={year}&month={month}&hide_freeze={hide_freeze}&page_index={page_index}&page_size={page_size}	No documentation available.
POST payment/trade_pay_offline	No documentation available.
POST payment/trade_pay_off_line	No documentation available.

Home

API	Description
GET home/get_all_home_page?user_id={user_id}	显示首页的内容
GET home/change_another_top_course	换一批

Message

该模块用于消息模块

API	Description
GET message/get_message_list?page_index={page_index}&page_size={page_size}	获取我的留言消息
GET message/get_course_comment_list?course_id={course_id}&page_index={page_index}&page_size={page_size}	获取评论列表
POST message/comment_course	评论课程
POST message/send_chat_message	No documentation available.
POST message/send_text	No documentation available.
POST message/send_item	No documentation available.
POST message/send_voice	No documentation available.
POST message/send_photo	No documentation available.
POST message/send_location	No documentation available.
POST message/send_messages	No documentation available.
PATCH message/update_notification_setting	No documentation available.
PATCH message/update_device_token	No documentation available.
GET message/get_unreceived_message_list/{id}	No documentation available.
GET message/get_unreceived_message_list	No documentation available.
GET message/get_unread_message_list?group_id={group_id}&page_index={page_index}&page_size={page_size}	No documentation available.
GET message/get_unread_message_list_paging?group_id={group_id}&page_index={page_index}&page_size={page_size}	No documentation available.
GET message/msg_get_message_chat_group_list?page_index={page_index}&page_size={page_size}	No documentation available.
GET message/msg_get_message_chat_list?target_user_id={target_user_id}&page_index={page_index}&page_size={page_size}	No documentation available.
GET message/get_unread_message_group_list	No documentation available.
DELETE message/delete_message_list/{id}	No documentation available.
DELETE message/delete_message/{id}	No documentation available.
PATCH message/receive_message	No documentation available.
PATCH message/read_message	No documentation available.
PATCH message/play_message/{id}	No documentation available.
POST message/connect	No documentation available.
POST message/disconnect	No documentation available.
POST message/add_mute_notification	No documentation available.
POST message/remove_mute_notification	No documentation available.

ChunTianConfig

该模块用于关于我们

API	Description
GET chun_tian_config/get_about_us	获取关于我们

News

API	Description
GET news/get_news?news_id={news_id}&news_ids={news_ids}&region_id={region_id}&shop_ids={shop_ids}&shop_id={shop_id}&client_id={client_id}&format={format}&news_group_id={news_group_id}&news_group_name={news_group_name}&news_type_group_id={news_type_group_id}&news_type_id={news_type_id}&news_type_ids={news_type_ids}&keywords={keywords}&date_from={date_from}&date_to={date_to}&stick={stick}&hot={hot}&recommend={recommend}&read={read}&has_cover_image={has_cover_image}&page_index={page_index}&page_size={page_size}	No documentation available.
GET news/get_news_list?news_id={news_id}&news_ids={news_ids}&region_id={region_id}&shop_ids={shop_ids}&shop_id={shop_id}&client_id={client_id}&format={format}&news_group_id={news_group_id}&news_group_name={news_group_name}&news_type_group_id={news_type_group_id}&news_type_id={news_type_id}&news_type_ids={news_type_ids}&keywords={keywords}&date_from={date_from}&date_to={date_to}&stick={stick}&hot={hot}&recommend={recommend}&read={read}&has_cover_image={has_cover_image}&page_index={page_index}&page_size={page_size}	No documentation available.
GET news/get_news_detail?news_id={news_id}&client_id={client_id}&format={format}&user_id={user_id}&has_comment_and_like={has_comment_and_like}	No documentation available.
GET news/get_news_type/{client_id}	No documentation available.
GET news/create_news_image?news_id={news_id}&client_id={client_id}	No documentation available.
GET news/get_collected_news_list?shop_id={shop_id}&client_id={client_id}&format={format}&page_index={page_index}&page_size={page_size}	No documentation available.
GET news/detail?news_id={news_id}&client_id={client_id}&format={format}&user_id={user_id}&has_comment_and_like={has_comment_and_like}	No documentation available.
POST news/collect_news	No documentation available.
GET news/get_comment_list?news_id={news_id}&page_index={page_index}&page_size={page_size}	No documentation available.
POST news/comment	No documentation available.
POST news/delete_comment	No documentation available.
POST news/like	No documentation available.

Netease

API	Description
POST netease/create_channel	创建一个直播频道
POST netease/record_callback	直播录制成功后回调
POST netease/channel_status_callback	频道状态修改回调
POST netease/set_record_callback	设置视频录制回调地址
POST netease/set_channel_status_callback	设置频道状态回调地址
POST netease/callback	音视频录制回调

WeChat

API	Description
POST wechat/save_user_info	No documentation available.
POST wechat/wxa_register	No documentation available.
POST wechat/get_phone_number	No documentation available.
POST wechat/get_phone_number_anonymous	No documentation available.
GET wechat/contact_ipn?signature={signature}&timestamp={timestamp}&nonce={nonce}&echostr={echostr}	No documentation available.
POST wechat/contact_ipn	No documentation available.
POST wechat/subscribe_user_message_template	No documentation available.
POST wechat/book_wxa_message	No documentation available.

ApiSystem

API	Description
GET system/ping	No documentation available.

Order

该模块用于订单

API	Description
GET order/get_order_list?order_status_id={order_status_id}&page_index={page_index}&page_size={page_size}	获取订单列表
GET order/get_order_detail/{order_id}	获取订单详情
GET order/delete_order/{order_id}	删除订单
GET order/cancel_order/{order_id}	取消订单
POST order/create_order?courseId={courseId}&couponId={couponId}	生成订单

Introduction

Entity

Promotion

Account

Course

File

Banner

User

Payment

Home

Message

ChunTianConfig

News

Netease

WeChat

ApiSystem

Order