更新月度总结API文档

本文档描述了如何使用更新月度总结API手动更新体适能评估记录的月度总结内容。

API概述

更新月度总结API提供了手动更新体适能评估记录月度总结内容的功能,可以用于教练或会员在月度评估后对训练效果进行总结。

接口详情

更新月度总结

POST /gym/member/update_monthly_summary

更新指定体适能评估记录的月度总结内容。

请求参数

参数名 类型 必填 描述
assessment_id Integer 体适能评估ID
summary String 新的月度总结内容

响应格式

API返回JSON格式的数据,包含以下字段:

{
    "error": 0,                      // 错误码,0表示成功,非0表示失败
    "message": "月度总结更新成功",     // 响应消息
    "assessment_id": 123,            // 体适能评估ID
    "summary": "这是更新后的月度总结内容..." // 更新后的月度总结内容
}

错误码说明

错误码 描述
0 成功
400 请求参数错误,如缺少必要参数
404 未找到指定体适能评估记录
500 服务器内部错误

示例请求

POST /gym/member/update_monthly_summary
Content-Type: application/x-www-form-urlencoded

assessment_id=123&summary=这是新的月度总结内容,包含了对训练效果的评估和建议。

使用示例

JavaScript示例

// 使用fetch API更新月度总结
const updateMonthlySummary = async (assessmentId, summary) => {
    try {
        const formData = new FormData();
        formData.append('assessment_id', assessmentId);
        formData.append('summary', summary);
        
        const response = await fetch('/gym/member/update_monthly_summary', {
            method: 'POST',
            body: formData,
            headers: {
                'Authorization': 'Bearer ' + accessToken
            }
        });
        
        const data = await response.json();
        
        if (data.error === 0) {
            console.log('月度总结更新成功:', data.message);
            return data;
        } else {
            console.error('更新失败:', data.message);
            throw new Error(data.message);
        }
    } catch (error) {
        console.error('请求出错:', error);
        throw error;
    }
};

// 调用示例
updateMonthlySummary(123, '这是新的月度总结内容,包含了对训练效果的评估和建议。')
    .then(data => {
        // 处理成功响应
        console.log('更新后的总结:', data.summary);
    })
    .catch(error => {
        // 处理错误
        console.error('更新月度总结失败:', error);
    });

使用JSON格式发送请求

// 使用fetch API发送JSON格式请求
const updateMonthlySummaryJson = async (assessmentId, summary) => {
    try {
        const response = await fetch('/gym/member/update_monthly_summary', {
            method: 'POST',
            body: JSON.stringify({
                assessment_id: assessmentId,
                summary: summary
            }),
            headers: {
                'Content-Type': 'application/json',
                'Authorization': 'Bearer ' + accessToken
            }
        });
        
        const data = await response.json();
        
        if (data.error === 0) {
            console.log('月度总结更新成功:', data.message);
            return data;
        } else {
            console.error('更新失败:', data.message);
            throw new Error(data.message);
        }
    } catch (error) {
        console.error('请求出错:', error);
        throw error;
    }
};

Python示例

import requests

def update_monthly_summary(assessment_id, summary, access_token):
    """
    更新月度总结
    
    Args:
        assessment_id: 体适能评估ID
        summary: 新的月度总结内容
        access_token: 访问令牌
    
    Returns:
        更新结果
    """
    url = 'http://your-domain.com/gym/member/update_monthly_summary'
    
    headers = {
        'Authorization': f'Bearer {access_token}'
    }
    
    data = {
        'assessment_id': assessment_id,
        'summary': summary
    }
    
    response = requests.post(url, data=data, headers=headers)
    
    if response.status_code == 200:
        result = response.json()
        if result['error'] == 0:
            print(f"月度总结更新成功: {result['message']}")
            return result
        else:
            print(f"更新失败: {result['message']}")
            raise Exception(result['message'])
    else:
        print(f"请求失败,状态码: {response.status_code}")
        raise Exception(f"请求失败,状态码: {response.status_code}")

# 调用示例
try:
    result = update_monthly_summary(
        assessment_id=123,
        summary='这是新的月度总结内容,包含了对训练效果的评估和建议。',
        access_token='your-access-token'
    )
    print(f"更新后的总结: {result['summary']}")
except Exception as e:
    print(f"更新月度总结失败: {str(e)}")