卡片目标导入(腾讯公益为被调)
接口名称
PostCardInfo
使用场景
部分有开发能力的机构可以使用本接口推送项目卡片目标进行项目捐款卡片的初始化。同时支持卡片的修改,注意卡片修改需要带card_id参数,仅未上线、未筹过款的卡片才允许修改,项目id、学校id、受助人id不允许修改。
请求地址
https://oapi.gongyi.qq.com/api/tmj_third_service/PostCardInfo
请求方式
POST
请求参数
header参数
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
Gy-H-Api-Appid | string | 采用签名认证方式时,必填 | 应用id,由开放平台分配给应用的唯一ID |
Gy-H-Api-Nonce-Str | string | 采用签名认证方式时,必填 | 随机值,可以是数字和字母的组合;长度32位;应用侧生成,保证唯一即可 |
Gy-H-Api-Timestamp | uint32 | 采用签名认证方式时,必填 | 时间戳,单位s |
Gy-H-Api-Sign | string | 采用签名认证方式时,必填 | 使用应用的密钥,通过HMAC-SHA256算法签名后,得出的结果,详见签名说明 |
post参数
参数 | 类型 | 长度 | 是否必填 | 说明 | 是否可修改 |
---|---|---|---|---|---|
card_id | string | 20位字符 | 否 | 卡片id,如需做卡片更新操作,需要带此字段 | 否 |
project_id | uint32 | 10位字符 | 是 | 项目id | 否 |
project_name | string | 9 位字符 | 是 | 项目名称 | 否 |
card_target_description | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 卡片目标描述,例:为上坪镇小学筹集一台净水设备 注: 如果这个字段缺失,服务后端会自己拼接一个卡片目标描述, 例如 "帮助XXXX等筹集XXXX" |
否 |
help_org_number | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 执行地点组织id,如:学校id | 否 |
help_org_name | string | 20位字符 | 是 | 执行地点名称,如:学校名称 | 是 |
help_org_address | object | - | 是 | 执行地址 | - |
help_org_address.province | string | 30位字符 | 是 | 执行地址省份,如:广东省 | 是 |
help_org_address.city | string | 30位字符 | 是 | 执行地址市,如:河源市 | 是 |
help_org_address.area | string | 30位字符 | 否 | 执行地址区(县),如:连平县 | 是 |
help_org_address.detail | string | 30位字符 | 否 | 执行地址详细地址,如:上坪镇 | 是 |
help_list | array | - | 是 | 受助人列表(反馈维度到"2-受助人维度",才必填) | |
help_list.stu_id | string | 30位字符 | 是 | 受助人id(反馈维度到"2-受助人维度",才必填) | 否 |
help_list.stu_name | string | 20位字符 | 是 | 受助人姓名(全名,对外展示时会脱敏)(反馈维度到"2-受助人维度",才必填) | 是 |
help_list.stu_age | uint32 | 1 - 150 之间 | 当卡片资助类型为"物资"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 受助人年龄 | 是 |
help_list.stu_sex | string | 1位字符 | 当卡片资助类型为"物资"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 受助人性别,如:男、女 | 是 |
help_list.id_card | string | 18位字符 | 当卡片资助类型为"现金"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 受助人身份证号(仅做校验,不对C端展示) | 是 |
help_list.school_grade_class | string | 12位字符 |
所在组织为"学校"时必填,其他场景非必填 | 受助人所在年级, 例:一年级,二年级,三年级,四年级,五年级,六年级,七年级,八年级,九年级,高一,高二,高三,大一,大二,大三,大四,大五。 |
是 |
help_list.stu_home_situation | string | 100位字符 | 当卡片捐款方式为一对一,其他场景非必填 | 受助人家庭情况 | 是 |
help_list.stu_disease_situation | string | 100位字符 | 否 | 受助人疾病情况 | 是 |
help_list.stu_funding_options | string | 100位字符 | 否 | 对受助人的走访意见 | 是 |
help_list.money | string | 不超过 10000元 |
是 | 对受助人的资助标准(金额/元,如有小数最多保留两位) |
否 |
help_list.help_org_type | uint32 | 1位字符 | 是 | 所属组织类型, 1-学校, 2-其他 | 是 |
help_list.school_name_simple | string | 20位字符 | 是 | 所在组织为学校时填学校名称,其他场景则填非学校的地点,例如:村委会 | 是 |
help_list.stu_images | string array | - | 否 | 辅助介绍照片,例如受助人家庭情况照片,要求单张大小不要超过10MB,最多3张,支持jpg、png格式。 | 是 |
help_list.fundras_target | string | 不超过 10000元 | 是 | 筹款金额(含管理费) | 否 |
help_list.identity | string | 3位字符 | 所在组织为"学校"时必填,其他场景非必填 | 受助人身份, 例:小学生, 中学生, 大学生。 | 是 |
help_list.customize_field | string | 20位字符 | 否 | 自定义字段的字段名称,例,"受助人心愿" | 是 |
help_list.customize_value | string | 100位字符 | 否 | 自定义字段的字段内容,例,受助人心愿的具体内容,即"我想考上武汉大学,不辜负父母和老师的期望" | 是 |
help_list.guardian_id_card | string | 18位字符 | 否 |
监护人身份证 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 ``这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_phone_number | string | 11 位字符 | 否 |
监护人手机 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 ``这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_name | string | 20位字符 | 否 |
监护人姓名 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 ``这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_relation | string | 10位字符 |
否 |
与监护人的关系 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 ``这四个字段,要么全部填,要么全不填 |
是 |
help_thing_count | uint32 | 1~1,000,000,000 | 是 | 资助物品数量,如:300 | 否 |
help_thing_target | string | 30位字符 | 是 | 资助目标金额(金额/元,如有小数最多保留两位) | 否 |
assistance_cycle_start_date | string | - | 当反馈目标维度为受助人且卡片资助类型为"现金"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 帮扶周期开始时间,结束时间需大于当天时间且大于开始时间,格式:2006-01-02 | 是 |
assistance_cycle_end_date | string | - | 当反馈目标维度为受助人且卡片资助类型为"现金"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 帮扶周期结束时间,结束时间需大于当天时间且大于开始时间,格式:2006-01-02 | 是 |
error_code | uint32 | - | 否 | 该字段为可选字段,取值来源于系统错误码:100100、100200、100500、100101、100201、100501、200102、200201、200203, 详情见错误码表6.1.1,该接口用于mock返回相应的错误码响应和回调,便于机构在测试环境调试 |
是 |
场景区分
场景一参数
参数 | 类型 | 长度 | 是否必填 | 说明 | 是否可修改 |
---|---|---|---|---|---|
card_id | string | 20位字符 | 否 | 卡片id,如需做卡片更新操作,需要带此字段 | 否 |
project_id | uint32 | 10位字符 | 是 | 项目id | 否 |
project_name | string | 9 位字符 | 是 | 项目名称 | 否 |
card_target_description | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 卡片目标描述,例:为上坪镇小学筹集一台净水设备 注: 如果这个字段缺失,服务后端会自己拼接一个卡片目标描述, 例如 "帮助XXXX等筹集XXXX" |
否 |
help_org_number | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 执行地点组织id,如:学校id | 否 |
help_org_name | string | 20位字符 | 是 | 执行地点名称,如:学校名称 | 是 |
help_org_address | object | - | 是 | 执行地址 | - |
help_org_address.province | string | 30位字符 | 是 | 执行地址省份,如:广东省 | 是 |
help_org_address.city | string | 30位字符 | 是 | 执行地址市,如:河源市 | 是 |
help_org_address.area | string | 30位字符 | 否 | 执行地址区(县),如:连平县 | 是 |
help_org_address.detail | string | 30位字符 | 否 | 执行地址详细地址,如:上坪镇 | 是 |
help_thing_count | uint32 | 1~1,000,000,000 | 是 | 资助物品数量,如:300 | 否 |
help_thing_target | string | 30位字符 | 是 | 资助目标金额(金额/元,如有小数最多保留两位) | 否 |
error_code | uint32 | - | 否 | 该字段为可选字段,取值来源于系统错误码:100100、100200、100500、100101、100201、100501、200102、200201、200203, 详情见错误码表6.1.1,该接口用于mock返回相应的错误码响应和回调,便于机构在测试环境调试 |
是 |
场景二参数
参数 | 类型 | 长度 | 是否必填 | 说明 | 是否可修改 |
---|---|---|---|---|---|
card_id | string | 20位字符 | 否 | 卡片id,如需做卡片更新操作,需要带此字段 | 否 |
project_id | uint32 | 10位字符 | 是 | 项目id | 否 |
project_name | string | 9 位字符 | 是 | 项目名称 | 否 |
card_target_description | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 卡片目标描述,例:为上坪镇小学筹集一台净水设备 注: 如果这个字段缺失,服务后端会自己拼接一个卡片目标描述, 例如 "帮助XXXX等筹集XXXX" |
否 |
help_org_number | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 执行地点组织id,如:学校id | 否 |
help_org_name | string | 20位字符 | 是 | 执行地点名称,如:学校名称 | 是 |
help_org_address | object | - | 是 | 执行地址 | - |
help_org_address.province | string | 30位字符 | 是 | 执行地址省份,如:广东省 | 是 |
help_org_address.city | string | 30位字符 | 是 | 执行地址市,如:河源市 | 是 |
help_org_address.area | string | 30位字符 | 否 | 执行地址区(县),如:连平县 | 是 |
help_org_address.detail | string | 30位字符 | 否 | 执行地址详细地址,如:上坪镇 | 是 |
help_list | array | - | 是 | 受助人列表(反馈维度到"2-受助人维度",才必填) | |
help_list.stu_id | string | 30位字符 | 是 | 受助人id(反馈维度到"2-受助人维度",才必填) | 否 |
help_list.stu_name | string | 20位字符 | 是 | 受助人姓名(全名,对外展示时会脱敏)(反馈维度到"2-受助人维度",才必填) | 是 |
help_list.stu_age | uint32 | 1 - 150 之间 | 当卡片资助类型为"物资"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 受助人年龄 | 是 |
help_list.stu_sex | string | 1位字符 | 当卡片资助类型为"物资"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 受助人性别,如:男、女 | 是 |
help_list.school_grade_class | string | 12位字符 |
所在组织为"学校"时必填,其他场景非必填 | 受助人所在年级, 例:一年级,二年级,三年级,四年级,五年级,六年级,七年级,八年级,九年级,高一,高二,高三,大一,大二,大三,大四,大五。 |
是 |
help_list.stu_home_situation | string | 100位字符 | 当卡片捐款方式为一对一,其他场景非必填 | 受助人家庭情况 | 是 |
help_list.stu_disease_situation | string | 100位字符 | 否 | 受助人疾病情况 | 是 |
help_list.stu_funding_options | string | 100位字符 | 否 | 对受助人的走访意见 | 是 |
help_list.money | string | 不超过 10000元 |
是 | 对受助人的资助标准(金额/元,如有小数最多保留两位) |
否 |
help_list.help_org_type | uint32 | 1位字符 | 是 | 所属组织类型, 1-学校, 2-其他 | 是 |
help_list.school_name_simple | string | 20位字符 | 是 | 所在组织为学校时填学校名称,其他场景则填非学校的地点,例如:村委会 | 是 |
help_list.stu_images | string array | - | 否 | 辅助介绍照片,例如受助人家庭情况照片,要求单张大小不要超过10MB,最多3张,支持jpg、png格式。 | 是 |
help_list.fundras_target | string | 不超过 10000元 | 是 | 筹款金额(含管理费) | 否 |
help_list.identity | string | 3位字符 | 所在组织为"学校"时必填,其他场景非必填 | 受助人身份, 例:小学生, 中学生, 大学生。 | 是 |
help_list.customize_field | string | 20位字符 | 否 | 自定义字段的字段名称,例,"受助人心愿" | 是 |
help_list.customize_value | string | 100位字符 | 否 | 自定义字段的字段内容,例,受助人心愿的具体内容,即"我想考上武汉大学,不辜负父母和老师的期望" | 是 |
help_list.guardian_id_card | string | 18位字符 | 否 |
监护人身份证 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_phone_number | string | 11 位字符 | 否 |
监护人手机 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_name | string | 20位字符 | 否 |
监护人姓名 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_relation | string | 10位字符 |
否 |
与监护人的关系 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_thing_count | uint32 | 1~1,000,000,000 | 是 | 资助物品数量,如:300 | 否 |
help_thing_target | string | 30位字符 | 是 | 资助目标金额(金额/元,如有小数最多保留两位) | 否 |
error_code | uint32 | - | 否 | 该字段为可选字段,取值来源于系统错误码:100100、100200、100500、100101、100201、100501、200102、200201、200203, 详情见错误码表6.1.1,该接口用于mock返回相应的错误码响应和回调,便于机构在测试环境调试 |
是 |
场景三参数
参数 | 类型 | 长度 | 是否必填 | 说明 | 是否可修改 |
---|---|---|---|---|---|
card_id | string | 20位字符 | 否 | 卡片id,如需做卡片更新操作,需要带此字段 | 否 |
project_id | uint32 | 10位字符 | 是 | 项目id | 否 |
project_name | string | 9 位字符 | 是 | 项目名称 | 否 |
card_target_description | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 卡片目标描述,例:为上坪镇小学筹集一台净水设备 注: 如果这个字段缺失,服务后端会自己拼接一个卡片目标描述, 例如 "帮助XXXX等筹集XXXX" |
否 |
help_org_number | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 执行地点组织id,如:学校id | 否 |
help_org_name | string | 20位字符 | 是 | 执行地点名称,如:学校名称 | 是 |
help_org_address | object | - | 是 | 执行地址 | - |
help_org_address.province | string | 30位字符 | 是 | 执行地址省份,如:广东省 | 是 |
help_org_address.city | string | 30位字符 | 是 | 执行地址市,如:河源市 | 是 |
help_org_address.area | string | 30位字符 | 否 | 执行地址区(县),如:连平县 | 是 |
help_org_address.detail | string | 30位字符 | 否 | 执行地址详细地址,如:上坪镇 | 是 |
help_list | array | - | 是 | 受助人列表(反馈维度到"2-受助人维度",才必填) | |
help_list.stu_id | string | 30位字符 | 是 | 受助人id(反馈维度到"2-受助人维度",才必填) | 否 |
help_list.stu_name | string | 20位字符 | 是 | 受助人姓名(全名,对外展示时会脱敏)(反馈维度到"2-受助人维度",才必填) | 是 |
help_list.id_card | string | 18位字符 | 当卡片资助类型为"现金"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 受助人身份证号(仅做校验,不对C端展示) | 是 |
help_list.school_grade_class | string | 12位字符 |
所在组织为"学校"时必填,其他场景非必填 | 受助人所在年级, 例:一年级,二年级,三年级,四年级,五年级,六年级,七年级,八年级,九年级,高一,高二,高三,大一,大二,大三,大四,大五。 |
是 |
help_list.stu_disease_situation | string | 100位字符 | 否 | 受助人疾病情况 | 是 |
help_list.stu_funding_options | string | 100位字符 | 否 | 对受助人的走访意见 | 是 |
help_list.money | string | 不超过 10000元 |
是 | 对受助人的资助标准(金额/元,如有小数最多保留两位) |
否 |
help_list.help_org_type | uint32 | 1位字符 | 是 | 所属组织类型, 1-学校, 2-其他 | 是 |
help_list.school_name_simple | string | 20位字符 | 是 | 所在组织为学校时填学校名称,其他场景则填非学校的地点,例如:村委会 | 是 |
help_list.stu_images | string array | - | 否 | 辅助介绍照片,例如受助人家庭情况照片,要求单张大小不要超过10MB,最多3张,支持jpg、png格式。 | 是 |
help_list.fundras_target | string | 不超过 10000元 | 是 | 筹款金额(含管理费) | 否 |
help_list.identity | string | 3位字符 | 所在组织为"学校"时必填,其他场景非必填 | 受助人身份, 例:小学生, 中学生, 大学生。 | 是 |
help_list.customize_field | string | 20位字符 | 否 | 自定义字段的字段名称,例,"受助人心愿" | 是 |
help_list.customize_value | string | 100位字符 | 否 | 自定义字段的字段内容,例,受助人心愿的具体内容,即"我想考上武汉大学,不辜负父母和老师的期望" | 是 |
help_list.guardian_id_card | string | 18位字符 | 否 |
监护人身份证 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_phone_number | string | 11 位字符 | 否 |
监护人手机 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_name | string | 20位字符 | 否 |
监护人姓名 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_relation | string | 10位字符 |
否 |
与监护人的关系 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_thing_count | uint32 | 1~1,000,000,000 | 是 | 资助物品数量,如:300 | 否 |
help_thing_target | string | 30位字符 | 是 | 资助目标金额(金额/元,如有小数最多保留两位) | 否 |
assistance_cycle_start_date | string | - | 当反馈目标维度为受助人且卡片资助类型为"现金"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 帮扶周期开始时间,结束时间需大于当天时间且大于开始时间,格式:2006-01-02 | 是 |
assistance_cycle_end_date | string | - | 当反馈目标维度为受助人且卡片资助类型为"现金"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 帮扶周期结束时间,结束时间需大于当天时间且大于开始时间,格式:2006-01-02 | 是 |
error_code | uint32 | - | 否 | 该字段为可选字段,取值来源于系统错误码:100100、100200、100500、100101、100201、100501、200102、200201、200203, 详情见错误码表6.1.1,该接口用于mock返回相应的错误码响应和回调,便于机构在测试环境调试 |
是 |
场景四参数
参数 | 类型 | 长度 | 是否必填 | 说明 | 是否可修改 |
---|---|---|---|---|---|
card_id | string | 20位字符 | 否 | 卡片id,如需做卡片更新操作,需要带此字段 | 否 |
project_id | uint32 | 10位字符 | 是 | 项目id | 否 |
project_name | string | 9 位字符 | 是 | 项目名称 | 否 |
card_target_description | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 卡片目标描述,例:为上坪镇小学筹集一台净水设备 注: 如果这个字段缺失,服务后端会自己拼接一个卡片目标描述, 例如 "帮助XXXX等筹集XXXX" |
否 |
help_org_number | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 执行地点组织id,如:学校id | 否 |
help_org_name | string | 20位字符 | 是 | 执行地点名称,如:学校名称 | 是 |
help_org_address | object | - | 是 | 执行地址 | - |
help_org_address.province | string | 30位字符 | 是 | 执行地址省份,如:广东省 | 是 |
help_org_address.city | string | 30位字符 | 是 | 执行地址市,如:河源市 | 是 |
help_org_address.area | string | 30位字符 | 否 | 执行地址区(县),如:连平县 | 是 |
help_org_address.detail | string | 30位字符 | 否 | 执行地址详细地址,如:上坪镇 | 是 |
help_list | array | - | 是 | 受助人列表(反馈维度到"2-受助人维度",才必填) | |
help_list.stu_id | string | 30位字符 | 是 | 受助人id(反馈维度到"2-受助人维度",才必填) | 否 |
help_list.stu_name | string | 20位字符 | 是 | 受助人姓名(全名,对外展示时会脱敏)(反馈维度到"2-受助人维度",才必填) | 是 |
help_list.stu_age | uint32 | 1 - 150 之间 | 当卡片资助类型为"物资"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 受助人年龄 | 是 |
help_list.stu_sex | string | 1位字符 | 当卡片资助类型为"物资"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 受助人性别,如:男、女 | 是 |
help_list.school_grade_class | string | 12位字符 |
所在组织为"学校"时必填,其他场景非必填 | 受助人所在年级, 例:一年级,二年级,三年级,四年级,五年级,六年级,七年级,八年级,九年级,高一,高二,高三,大一,大二,大三,大四,大五。 |
是 |
help_list.stu_home_situation | string | 100位字符 | 当卡片捐款方式为一对一,其他场景非必填 | 受助人家庭情况 | 是 |
help_list.stu_disease_situation | string | 100位字符 | 否 | 受助人疾病情况 | 是 |
help_list.stu_funding_options | string | 100位字符 | 否 | 对受助人的走访意见 | 是 |
help_list.money | string | 不超过 10000元 |
是 | 对受助人的资助标准(金额/元,如有小数最多保留两位) |
否 |
help_list.help_org_type | uint32 | 1位字符 | 是 | 所属组织类型, 1-学校, 2-其他 | 是 |
help_list.school_name_simple | string | 20位字符 | 是 | 所在组织为学校时填学校名称,其他场景则填非学校的地点,例如:村委会 | 是 |
help_list.stu_images | string array | - | 否 | 辅助介绍照片,例如受助人家庭情况照片,要求单张大小不要超过10MB,最多3张,支持jpg、png格式。 | 是 |
help_list.fundras_target | string | 不超过 10000元 | 是 | 筹款金额(含管理费) | 否 |
help_list.identity | string | 3位字符 | 所在组织为"学校"时必填,其他场景非必填 | 受助人身份, 例:小学生, 中学生, 大学生。 | 是 |
help_list.customize_field | string | 20位字符 | 否 | 自定义字段的字段名称,例,"受助人心愿" | 是 |
help_list.customize_value | string | 100位字符 | 否 | 自定义字段的字段内容,例,受助人心愿的具体内容,即"我想考上武汉大学,不辜负父母和老师的期望" | 是 |
help_list.guardian_id_card | string | 18位字符 | 否 |
监护人身份证 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_phone_number | string | 11 位字符 | 否 |
监护人手机 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_name | string | 20位字符 | 否 |
监护人姓名 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_relation | string | 10位字符 |
否 |
与监护人的关系 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_thing_count | uint32 | 1~1,000,000,000 | 是 | 资助物品数量,如:300 | 否 |
help_thing_target | string | 30位字符 | 是 | 资助目标金额(金额/元,如有小数最多保留两位) | 否 |
error_code | uint32 | - | 否 | 该字段为可选字段,取值来源于系统错误码:100100、100200、100500、100101、100201、100501、200102、200201、200203, 详情见错误码表6.1.1,该接口用于mock返回相应的错误码响应和回调,便于机构在测试环境调试 |
是 |
场景五参数
参数 | 类型 | 长度 | 是否必填 | 说明 | 是否可修改 |
---|---|---|---|---|---|
card_id | string | 20位字符 | 否 | 卡片id,如需做卡片更新操作,需要带此字段 | 否 |
project_id | uint32 | 10位字符 | 是 | 项目id | 否 |
project_name | string | 9 位字符 | 是 | 项目名称 | 否 |
card_target_description | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 卡片目标描述,例:为上坪镇小学筹集一台净水设备 注: 如果这个字段缺失,服务后端会自己拼接一个卡片目标描述, 例如 "帮助XXXX等筹集XXXX" |
否 |
help_org_number | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 执行地点组织id,如:学校id | 否 |
help_org_name | string | 20位字符 | 是 | 执行地点名称,如:学校名称 | 是 |
help_org_address | object | - | 是 | 执行地址 | - |
help_org_address.province | string | 30位字符 | 是 | 执行地址省份,如:广东省 | 是 |
help_org_address.city | string | 30位字符 | 是 | 执行地址市,如:河源市 | 是 |
help_org_address.area | string | 30位字符 | 否 | 执行地址区(县),如:连平县 | 是 |
help_org_address.detail | string | 30位字符 | 否 | 执行地址详细地址,如:上坪镇 | 是 |
help_list | array | - | 是 | 受助人列表(反馈维度到"2-受助人维度",才必填) | |
help_list.stu_id | string | 30位字符 | 是 | 受助人id(反馈维度到"2-受助人维度",才必填) | 否 |
help_list.stu_name | string | 20位字符 | 是 | 受助人姓名(全名,对外展示时会脱敏)(反馈维度到"2-受助人维度",才必填) | 是 |
help_list.id_card | string | 18位字符 | 当卡片资助类型为"现金"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 受助人身份证号(仅做校验,不对C端展示) | 是 |
help_list.school_grade_class | string | 12位字符 |
所在组织为"学校"时必填,其他场景非必填 | 受助人所在年级, 例:一年级,二年级,三年级,四年级,五年级,六年级,七年级,八年级,九年级,高一,高二,高三,大一,大二,大三,大四,大五。 |
是 |
help_list.stu_home_situation | string | 100位字符 | 当卡片捐款方式为一对一,其他场景非必填 | 受助人家庭情况 | 是 |
help_list.stu_disease_situation | string | 100位字符 | 否 | 受助人疾病情况 | 是 |
help_list.stu_funding_options | string | 100位字符 | 否 | 对受助人的走访意见 | 是 |
help_list.money | string | 不超过 10000元 |
是 | 对受助人的资助标准(金额/元,如有小数最多保留两位) |
否 |
help_list.help_org_type | uint32 | 1位字符 | 是 | 所属组织类型, 1-学校, 2-其他 | 是 |
help_list.school_name_simple | string | 20位字符 | 是 | 所在组织为学校时填学校名称,其他场景则填非学校的地点,例如:村委会 | 是 |
help_list.stu_images | string array | - | 否 | 辅助介绍照片,例如受助人家庭情况照片,要求单张大小不要超过10MB,最多3张,支持jpg、png格式。 | 是 |
help_list.fundras_target | string | 不超过 10000元 | 是 | 筹款金额(含管理费) | 否 |
help_list.identity | string | 3位字符 | 所在组织为"学校"时必填,其他场景非必填 | 受助人身份, 例:小学生, 中学生, 大学生。 | 是 |
help_list.customize_field | string | 20位字符 | 否 | 自定义字段的字段名称,例,"受助人心愿" | 是 |
help_list.customize_value | string | 100位字符 | 否 | 自定义字段的字段内容,例,受助人心愿的具体内容,即"我想考上武汉大学,不辜负父母和老师的期望" | 是 |
help_list.guardian_id_card | string | 18位字符 | 否 |
监护人身份证 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_phone_number | string | 11 位字符 | 否 |
监护人手机 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_name | string | 20位字符 | 否 |
监护人姓名 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_relation | string | 10位字符 |
否 |
与监护人的关系 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_thing_count | uint32 | 1~1,000,000,000 | 是 | 资助物品数量,如:300 | 否 |
help_thing_target | string | 30位字符 | 是 | 资助目标金额(金额/元,如有小数最多保留两位) | 否 |
assistance_cycle_start_date | string | - | 当反馈目标维度为受助人且卡片资助类型为"现金"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 帮扶周期开始时间,结束时间需大于当天时间且大于开始时间,格式:2006-01-02 | 是 |
assistance_cycle_end_date | string | - | 当反馈目标维度为受助人且卡片资助类型为"现金"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 帮扶周期结束时间,结束时间需大于当天时间且大于开始时间,格式:2006-01-02 | 是 |
error_code | uint32 | - | 否 | 该字段为可选字段,取值来源于系统错误码:100100、100200、100500、100101、100201、100501、200102、200201、200203, 详情见错误码表6.1.1,该接口用于mock返回相应的错误码响应和回调,便于机构在测试环境调试 |
是 |
场景六参数
参数 | 类型 | 长度 | 是否必填 | 说明 | 是否可修改 |
---|---|---|---|---|---|
card_id | string | 20位字符 | 否 | 卡片id,如需做卡片更新操作,需要带此字段 | 否 |
project_id | uint32 | 10位字符 | 是 | 项目id | 否 |
project_name | string | 9 位字符 | 是 | 项目名称 | 否 |
card_target_description | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 卡片目标描述,例:为上坪镇小学筹集一台净水设备 注: 如果这个字段缺失,服务后端会自己拼接一个卡片目标描述, 例如 "帮助XXXX等筹集XXXX" |
否 |
help_org_number | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 执行地点组织id,如:学校id | 否 |
help_org_name | string | 20位字符 | 是 | 执行地点名称,如:学校名称 | 是 |
help_org_address | object | - | 是 | 执行地址 | - |
help_org_address.province | string | 30位字符 | 是 | 执行地址省份,如:广东省 | 是 |
help_org_address.city | string | 30位字符 | 是 | 执行地址市,如:河源市 | 是 |
help_org_address.area | string | 30位字符 | 否 | 执行地址区(县),如:连平县 | 是 |
help_org_address.detail | string | 30位字符 | 否 | 执行地址详细地址,如:上坪镇 | 是 |
help_thing_count | uint32 | 1~1,000,000,000 | 是 | 资助物品数量,如:300 | 否 |
help_thing_target | string | 30位字符 | 是 | 资助目标金额(金额/元,如有小数最多保留两位) | 否 |
assistance_cycle_start_date | string | - | 当反馈目标维度为受助人且卡片资助类型为"现金"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 帮扶周期开始时间,结束时间需大于当天时间且大于开始时间,格式:2006-01-02 | 是 |
assistance_cycle_end_date | string | - | 当反馈目标维度为受助人且卡片资助类型为"现金"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 帮扶周期结束时间,结束时间需大于当天时间且大于开始时间,格式:2006-01-02 | 是 |
error_code | uint32 | - | 否 | 该字段为可选字段,取值来源于系统错误码:100100、100200、100500、100101、100201、100501、200102、200201、200203, 详情见错误码表6.1.1,该接口用于mock返回相应的错误码响应和回调,便于机构在测试环境调试 |
是 |
场景七参数
参数 | 类型 | 长度 | 是否必填 | 说明 | 是否可修改 |
---|---|---|---|---|---|
card_id | string | 20位字符 | 否 | 卡片id,如需做卡片更新操作,需要带此字段 | 否 |
project_id | uint32 | 10位字符 | 是 | 项目id | 否 |
project_name | string | 9 位字符 | 是 | 项目名称 | 否 |
card_target_description | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 卡片目标描述,例:为上坪镇小学筹集一台净水设备 注: 如果这个字段缺失,服务后端会自己拼接一个卡片目标描述, 例如 "帮助XXXX等筹集XXXX" |
否 |
help_org_number | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 执行地点组织id,如:学校id | 否 |
help_org_name | string | 20位字符 | 是 | 执行地点名称,如:学校名称 | 是 |
help_org_address | object | - | 是 | 执行地址 | - |
help_org_address.province | string | 30位字符 | 是 | 执行地址省份,如:广东省 | 是 |
help_org_address.city | string | 30位字符 | 是 | 执行地址市,如:河源市 | 是 |
help_org_address.area | string | 30位字符 | 否 | 执行地址区(县),如:连平县 | 是 |
help_org_address.detail | string | 30位字符 | 否 | 执行地址详细地址,如:上坪镇 | 是 |
help_list | array | - | 是 | 受助人列表(反馈维度到"2-受助人维度",才必填) | |
help_list.stu_id | string | 30位字符 | 是 | 受助人id(反馈维度到"2-受助人维度",才必填) | 否 |
help_list.stu_name | string | 20位字符 | 是 | 受助人姓名(全名,对外展示时会脱敏)(反馈维度到"2-受助人维度",才必填) | 是 |
help_list.stu_age | uint32 | 1 - 150 之间 | 当卡片资助类型为"物资"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 受助人年龄 | 是 |
help_list.stu_sex | string | 1位字符 | 当卡片资助类型为"物资"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 受助人性别,如:男、女 | 是 |
help_list.school_grade_class | string | 12位字符 |
所在组织为"学校"时必填,其他场景非必填 | 受助人所在年级, 例:一年级,二年级,三年级,四年级,五年级,六年级,七年级,八年级,九年级,高一,高二,高三,大一,大二,大三,大四,大五。 |
是 |
help_list.stu_home_situation | string | 100位字符 | 当卡片捐款方式为一对一,其他场景非必填 | 受助人家庭情况 | 是 |
help_list.stu_disease_situation | string | 100位字符 | 否 | 受助人疾病情况 | 是 |
help_list.stu_funding_options | string | 100位字符 | 否 | 对受助人的走访意见 | 是 |
help_list.money | string | 不超过 10000元 |
是 | 对受助人的资助标准(金额/元,如有小数最多保留两位) |
否 |
help_list.help_org_type | uint32 | 1位字符 | 是 | 所属组织类型, 1-学校, 2-其他 | 是 |
help_list.school_name_simple | string | 20位字符 | 是 | 所在组织为学校时填学校名称,其他场景则填非学校的地点,例如:村委会 | 是 |
help_list.stu_images | string array | - | 否 | 辅助介绍照片,例如受助人家庭情况照片,要求单张大小不要超过10MB,最多3张,支持jpg、png格式。 | 是 |
help_list.fundras_target | string | 不超过 10000元 | 是 | 筹款金额(含管理费) | 否 |
help_list.identity | string | 3位字符 | 所在组织为"学校"时必填,其他场景非必填 | 受助人身份, 例:小学生, 中学生, 大学生。 | 是 |
help_list.customize_field | string | 20位字符 | 否 | 自定义字段的字段名称,例,"受助人心愿" | 是 |
help_list.customize_value | string | 100位字符 | 否 | 自定义字段的字段内容,例,受助人心愿的具体内容,即"我想考上武汉大学,不辜负父母和老师的期望" | 是 |
help_list.guardian_id_card | string | 18位字符 | 否 |
监护人身份证 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_phone_number | string | 11 位字符 | 否 |
监护人手机 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_name | string | 20位字符 | 否 |
监护人姓名 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_relation | string | 10位字符 |
否 |
与监护人的关系 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_thing_count | uint32 | 1~1,000,000,000 | 是 | 资助物品数量,如:300 | 否 |
help_thing_target | string | 30位字符 | 是 | 资助目标金额(金额/元,如有小数最多保留两位) | 否 |
error_code | uint32 | - | 否 | 该字段为可选字段,取值来源于系统错误码:100100、100200、100500、100101、100201、100501、200102、200201、200203, 详情见错误码表6.1.1,该接口用于mock返回相应的错误码响应和回调,便于机构在测试环境调试 |
是 |
场景八参数
参数 | 类型 | 长度 | 是否必填 | 说明 | 是否可修改 |
---|---|---|---|---|---|
card_id | string | 20位字符 | 否 | 卡片id,如需做卡片更新操作,需要带此字段 | 否 |
project_id | uint32 | 10位字符 | 是 | 项目id | 否 |
project_name | string | 9 位字符 | 是 | 项目名称 | 否 |
card_target_description | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 卡片目标描述,例:为上坪镇小学筹集一台净水设备 注: 如果这个字段缺失,服务后端会自己拼接一个卡片目标描述, 例如 "帮助XXXX等筹集XXXX" |
否 |
help_org_number | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 执行地点组织id,如:学校id | 否 |
help_org_name | string | 20位字符 | 是 | 执行地点名称,如:学校名称 | 是 |
help_org_address | object | - | 是 | 执行地址 | - |
help_org_address.province | string | 30位字符 | 是 | 执行地址省份,如:广东省 | 是 |
help_org_address.city | string | 30位字符 | 是 | 执行地址市,如:河源市 | 是 |
help_org_address.area | string | 30位字符 | 否 | 执行地址区(县),如:连平县 | 是 |
help_org_address.detail | string | 30位字符 | 否 | 执行地址详细地址,如:上坪镇 | 是 |
help_list | array | - | 是 | 受助人列表(反馈维度到"2-受助人维度",才必填) | |
help_list.stu_id | string | 30位字符 | 是 | 受助人id(反馈维度到"2-受助人维度",才必填) | 否 |
help_list.stu_name | string | 20位字符 | 是 | 受助人姓名(全名,对外展示时会脱敏)(反馈维度到"2-受助人维度",才必填) | 是 |
help_list.id_card | string | 18位字符 | 当卡片资助类型为"现金"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 受助人身份证号(仅做校验,不对C端展示) | 是 |
help_list.school_grade_class | string | 12位字符 |
所在组织为"学校"时必填,其他场景非必填 | 受助人所在年级, 例:一年级,二年级,三年级,四年级,五年级,六年级,七年级,八年级,九年级,高一,高二,高三,大一,大二,大三,大四,大五。 |
是 |
help_list.stu_home_situation | string | 100位字符 | 当卡片捐款方式为一对一,其他场景非必填 | 受助人家庭情况 | 是 |
help_list.stu_disease_situation | string | 100位字符 | 否 | 受助人疾病情况 | 是 |
help_list.stu_funding_options | string | 100位字符 | 否 | 对受助人的走访意见 | 是 |
help_list.money | string | 不超过 10000元 |
是 | 对受助人的资助标准(金额/元,如有小数最多保留两位) |
否 |
help_list.help_org_type | uint32 | 1位字符 | 是 | 所属组织类型, 1-学校, 2-其他 | 是 |
help_list.school_name_simple | string | 20位字符 | 是 | 所在组织为学校时填学校名称,其他场景则填非学校的地点,例如:村委会 | 是 |
help_list.stu_images | string array | - | 否 | 辅助介绍照片,例如受助人家庭情况照片,要求单张大小不要超过10MB,最多3张,支持jpg、png格式。 | 是 |
help_list.fundras_target | string | 不超过 10000元 | 是 | 筹款金额(含管理费) | 否 |
help_list.identity | string | 3位字符 | 所在组织为"学校"时必填,其他场景非必填 | 受助人身份, 例:小学生, 中学生, 大学生。 | 是 |
help_list.customize_field | string | 20位字符 | 否 | 自定义字段的字段名称,例,"受助人心愿" | 是 |
help_list.customize_value | string | 100位字符 | 否 | 自定义字段的字段内容,例,受助人心愿的具体内容,即"我想考上武汉大学,不辜负父母和老师的期望" | 是 |
help_list.guardian_id_card | string | 18位字符 | 否 |
监护人身份证 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_phone_number | string | 11 位字符 | 否 |
监护人手机 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_name | string | 20位字符 | 否 |
监护人姓名 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_relation | string | 10位字符 |
否 |
与监护人的关系 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_thing_count | uint32 | 1~1,000,000,000 | 是 | 资助物品数量,如:300 | 否 |
help_thing_target | string | 30位字符 | 是 | 资助目标金额(金额/元,如有小数最多保留两位) | 否 |
assistance_cycle_start_date | string | - | 当反馈目标维度为受助人且卡片资助类型为"现金"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 帮扶周期开始时间,结束时间需大于当天时间且大于开始时间,格式:2006-01-02 | 是 |
assistance_cycle_end_date | string | - | 当反馈目标维度为受助人且卡片资助类型为"现金"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 帮扶周期结束时间,结束时间需大于当天时间且大于开始时间,格式:2006-01-02 | 是 |
error_code | uint32 | - | 否 | 该字段为可选字段,取值来源于系统错误码:100100、100200、100500、100101、100201、100501、200102、200201、200203, 详情见错误码表6.1.1,该接口用于mock返回相应的错误码响应和回调,便于机构在测试环境调试 |
是 |
场景九参数
参数 | 类型 | 长度 | 是否必填 | 说明 | 是否可修改 |
---|---|---|---|---|---|
card_id | string | 20位字符 | 否 | 卡片id,如需做卡片更新操作,需要带此字段 | 否 |
project_id | uint32 | 10位字符 | 是 | 项目id | 否 |
project_name | string | 9 位字符 | 是 | 项目名称 | 否 |
card_target_description | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 卡片目标描述,例:为上坪镇小学筹集一台净水设备 注: 如果这个字段缺失,服务后端会自己拼接一个卡片目标描述, 例如 "帮助XXXX等筹集XXXX" |
否 |
help_org_number | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 执行地点组织id,如:学校id | 否 |
help_org_name | string | 20位字符 | 是 | 执行地点名称,如:学校名称 | 是 |
help_org_address | object | - | 是 | 执行地址 | - |
help_org_address.province | string | 30位字符 | 是 | 执行地址省份,如:广东省 | 是 |
help_org_address.city | string | 30位字符 | 是 | 执行地址市,如:河源市 | 是 |
help_org_address.area | string | 30位字符 | 否 | 执行地址区(县),如:连平县 | 是 |
help_org_address.detail | string | 30位字符 | 否 | 执行地址详细地址,如:上坪镇 | 是 |
help_list | array | - | 是 | 受助人列表(反馈维度到"2-受助人维度",才必填) | |
help_list.stu_id | string | 30位字符 | 是 | 受助人id(反馈维度到"2-受助人维度",才必填) | 否 |
help_list.stu_name | string | 20位字符 | 是 | 受助人姓名(全名,对外展示时会脱敏)(反馈维度到"2-受助人维度",才必填) | 是 |
help_list.stu_age | uint32 | 1 - 150 之间 | 当卡片资助类型为"物资"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 受助人年龄 | 是 |
help_list.stu_sex | string | 1位字符 | 当卡片资助类型为"物资"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 受助人性别,如:男、女 | 是 |
help_list.school_grade_class | string | 12位字符 |
所在组织为"学校"时必填,其他场景非必填 | 受助人所在年级, 例:一年级,二年级,三年级,四年级,五年级,六年级,七年级,八年级,九年级,高一,高二,高三,大一,大二,大三,大四,大五。 |
是 |
help_list.stu_home_situation | string | 100位字符 | 当卡片捐款方式为一对一,其他场景非必填 | 受助人家庭情况 | 是 |
help_list.stu_disease_situation | string | 100位字符 | 否 | 受助人疾病情况 | 是 |
help_list.stu_funding_options | string | 100位字符 | 否 | 对受助人的走访意见 | 是 |
help_list.money | string | 不超过 10000元 |
是 | 对受助人的资助标准(金额/元,如有小数最多保留两位) |
否 |
help_list.help_org_type | uint32 | 1位字符 | 是 | 所属组织类型, 1-学校, 2-其他 | 是 |
help_list.school_name_simple | string | 20位字符 | 是 | 所在组织为学校时填学校名称,其他场景则填非学校的地点,例如:村委会 | 是 |
help_list.stu_images | string array | - | 否 | 辅助介绍照片,例如受助人家庭情况照片,要求单张大小不要超过10MB,最多3张,支持jpg、png格式。 | 是 |
help_list.fundras_target | string | 不超过 10000元 | 是 | 筹款金额(含管理费) | 否 |
help_list.identity | string | 3位字符 | 所在组织为"学校"时必填,其他场景非必填 | 受助人身份, 例:小学生, 中学生, 大学生。 | 是 |
help_list.customize_field | string | 20位字符 | 否 | 自定义字段的字段名称,例,"受助人心愿" | 是 |
help_list.customize_value | string | 100位字符 | 否 | 自定义字段的字段内容,例,受助人心愿的具体内容,即"我想考上武汉大学,不辜负父母和老师的期望" | 是 |
help_list.guardian_id_card | string | 18位字符 | 否 |
监护人身份证 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_phone_number | string | 11 位字符 | 否 |
监护人手机 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_name | string | 20位字符 | 否 |
监护人姓名 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_relation | string | 10位字符 |
否 |
与监护人的关系 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_thing_count | uint32 | 1~1,000,000,000 | 是 | 资助物品数量,如:300 | 否 |
help_thing_target | string | 30位字符 | 是 | 资助目标金额(金额/元,如有小数最多保留两位) | 否 |
error_code | uint32 | - | 否 | 该字段为可选字段,取值来源于系统错误码:100100、100200、100500、100101、100201、100501、200102、200201、200203, 详情见错误码表6.1.1,该接口用于mock返回相应的错误码响应和回调,便于机构在测试环境调试 |
是 |
场景十参数
参数 | 类型 | 长度 | 是否必填 | 说明 | 是否可修改 |
---|---|---|---|---|---|
card_id | string | 20位字符 | 否 | 卡片id,如需做卡片更新操作,需要带此字段 | 否 |
project_id | uint32 | 10位字符 | 是 | 项目id | 否 |
project_name | string | 9 位字符 | 是 | 项目名称 | 否 |
card_target_description | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 卡片目标描述,例:为上坪镇小学筹集一台净水设备 注: 如果这个字段缺失,服务后端会自己拼接一个卡片目标描述, 例如 "帮助XXXX等筹集XXXX" |
否 |
help_org_number | string | 20位字符 | card_target_description 和help_org_number二选一必填 | 执行地点组织id,如:学校id | 否 |
help_org_name | string | 20位字符 | 是 | 执行地点名称,如:学校名称 | 是 |
help_org_address | object | - | 是 | 执行地址 | - |
help_org_address.province | string | 30位字符 | 是 | 执行地址省份,如:广东省 | 是 |
help_org_address.city | string | 30位字符 | 是 | 执行地址市,如:河源市 | 是 |
help_org_address.area | string | 30位字符 | 否 | 执行地址区(县),如:连平县 | 是 |
help_org_address.detail | string | 30位字符 | 否 | 执行地址详细地址,如:上坪镇 | 是 |
help_list | array | - | 是 | 受助人列表(反馈维度到"2-受助人维度",才必填) | |
help_list.stu_id | string | 30位字符 | 是 | 受助人id(反馈维度到"2-受助人维度",才必填) | 否 |
help_list.stu_name | string | 20位字符 | 是 | 受助人姓名(全名,对外展示时会脱敏)(反馈维度到"2-受助人维度",才必填) | 是 |
help_list.id_card | string | 18位字符 | 当卡片资助类型为"现金"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 受助人身份证号(仅做校验,不对C端展示) | 是 |
help_list.school_grade_class | string | 12位字符 |
所在组织为"学校"时必填,其他场景非必填 | 受助人所在年级, 例:一年级,二年级,三年级,四年级,五年级,六年级,七年级,八年级,九年级,高一,高二,高三,大一,大二,大三,大四,大五。 |
是 |
help_list.stu_home_situation | string | 100位字符 | 当卡片捐款方式为一对一,其他场景非必填 | 受助人家庭情况 | 是 |
help_list.stu_disease_situation | string | 100位字符 | 否 | 受助人疾病情况 | 是 |
help_list.stu_funding_options | string | 100位字符 | 否 | 对受助人的走访意见 | 是 |
help_list.money | string | 不超过 10000元 |
是 | 对受助人的资助标准(金额/元,如有小数最多保留两位) |
否 |
help_list.help_org_type | uint32 | 1位字符 | 是 | 所属组织类型, 1-学校, 2-其他 | 是 |
help_list.school_name_simple | string | 20位字符 | 是 | 所在组织为学校时填学校名称,其他场景则填非学校的地点,例如:村委会 | 是 |
help_list.stu_images | string array | - | 否 | 辅助介绍照片,例如受助人家庭情况照片,要求单张大小不要超过10MB,最多3张,支持jpg、png格式。 | 是 |
help_list.fundras_target | string | 不超过 10000元 | 是 | 筹款金额(含管理费) | 否 |
help_list.identity | string | 3位字符 | 所在组织为"学校"时必填,其他场景非必填 | 受助人身份, 例:小学生, 中学生, 大学生。 | 是 |
help_list.customize_field | string | 20位字符 | 否 | 自定义字段的字段名称,例,"受助人心愿" | 是 |
help_list.customize_value | string | 100位字符 | 否 | 自定义字段的字段内容,例,受助人心愿的具体内容,即"我想考上武汉大学,不辜负父母和老师的期望" | 是 |
help_list.guardian_id_card | string | 18位字符 | 否 |
监护人身份证 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_phone_number | string | 11 位字符 | 否 |
监护人手机 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_name | string | 20位字符 | 否 |
监护人姓名 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_list.guardian_relation | string | 10位字符 |
否 |
与监护人的关系 注:监护人身份证 监护人手机 监护人姓名 与监护人的关系 这四个字段,要么全部填,要么全不填 |
是 |
help_thing_count | uint32 | 1~1,000,000,000 | 是 | 资助物品数量,如:300 | 否 |
help_thing_target | string | 30位字符 | 是 | 资助目标金额(金额/元,如有小数最多保留两位) | 否 |
assistance_cycle_start_date | string | - | 当反馈目标维度为受助人且卡片资助类型为"现金"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 帮扶周期开始时间,结束时间需大于当天时间且大于开始时间,格式:2006-01-02 | 是 |
assistance_cycle_end_date | string | - | 当反馈目标维度为受助人且卡片资助类型为"现金"(通过机构平台卡片配置查询)时必填,其他场景非必填 | 帮扶周期结束时间,结束时间需大于当天时间且大于开始时间,格式:2006-01-02 | 是 |
error_code | uint32 | - | 否 | 该字段为可选字段,取值来源于系统错误码:100100、100200、100500、100101、100201、100501、200102、200201、200203, 详情见错误码表6.1.1,该接口用于mock返回相应的错误码响应和回调,便于机构在测试环境调试 |
是 |