《项目系统接口定义》由会员分享，可在线阅读，更多相关《项目系统接口定义（7页珍藏版）》请在金锄头文库上搜索。
1、XX项目API接口说明文档（V1.0.）20XX年3月文档修改记录文档版本修改人修改时间修改内容V1.0孙炜2017-3-22新建V1.0.1孙鹏程2017-4-10修改V1.0.2王兆2017-4-10修改第1章 目录目录第 1 章接口规范 2第 2 章接口列表 22.1供应商接口 32.1.1 getAgentInfo 32.1.2 updateAgentInfo 52.1.3 synAgentResult 6第2章 接口规范2.1 必传参数描述2.2 可选参数描述2.3IT项目管理公共参数描述2.4异常处理第3章接口列表序号接口接口名称接口调用发起 方接口说明1供应商接口getAgent
2、lnfo供应商从ERP获取相关数据updateAgentlnfoERPERP冋步新增或修改的数据到供应商系 统synAgentResult供应商更新ERP冋步过来的数据的状态3.1 供应商接口3.1.1 getAgentInfo接口说明接口请求地址：接口格式：对象接口请求：POST接口发起方：供应商系统接口功能：请求参数通过Agent对象，传递过滤条件，返回相应的数据对象参数名称参数类型是否必填参数说明getAgentRequesMacstring是Mac地址tsynTimeLong是同步时间戳，用于验证is_successString是1同步，2未同步返回参数对象参数名称参数类型是否必 填参
3、数说明getAgentResponseListidstring是idagentCodestring是供应商编号agentNamestring是供应商名称agentEnNamestring否供应商英文名称agentTypestring是供应商类型？cityldstring是所属城市corporationstring否法人bankAccountlstring否银行帐户1bank2string否开户行2bankAccount2string否银行帐户2is_validstring否是否有效，1有效0失效Is_delString是0未删除1已删除remarksstring否备注synTimelong是同
4、步时间戳，用于验证SynBackupsynBackupstring是涉及的表：sal_ agen t调整的字段：alter table sal_agent add (IS_SUCCESS INTEGER default 2 null,AGENT_STATE VARCHAR2(2); commen t on column sal_agen t.IS_SUCCESS is 1 未同步 2 已同步；comment on column sal_agent.agent_state is 是否为异地代理商 0 否 1 是；ERP 处理逻辑：1. ERP 数据表需要增加【同步状态】字段，默认新增时 1 成功
5、，2 失败。；查询什么样的控制数 据，有供应商系统传入该参数返回结果以后，供应商系统需要再次调用：sysAgentRequest接口反馈数据修改是否成功；3.1.2 updateAgentInfo接口说明接口地址：接口格式：对象接口请求：POST接口发起方：ERP系统接口功能：ERP同步新增或修改的数据到供应商系统。请求参数对象参数名称参数类型是否必填参数说明AgentRequestAge ntidstring是IdagentCodestring否供应商编号agentNamestring否供应商名称agentEnNamestring否供应商英文名称agentTypestring否供应商类型？c
6、ityldstring否所属城市corporationstring否法人reckoningZipCode2string否帐单地址2邮编banklstring否开户行1bankAccountlstring否银行帐户1bank2string否开户行2bankAccount2string否银行帐户2is_validstring否是否有效，1有效0失效Is_delString是0未删除1已删除remarksstring否备注synTimelong是同步时间戳，用于验证SynBackupstring是备注Macstring是Mac地址返回参数对象参数名称参数类型是否必填参数说明AgentResponse
7、SynResultresultInt是1:成功2：失败Idstring否返回idcontentstring否如果错误，发送错误原因synTimeLong是同步时间戳，用于验证Macstring是Mac地址3.1.3 synAgentResult接口说明接口地址：接口格式：对象接口请求：POST接口发起方：供应商系统接口功能：更新ERP同步过来的数据的状态。请求参数对象参数名称参数类 型是否必 填参数说明sysAgentRequestSynResult （结果集）resultInt是1:成功2：失败Idstring否返回idcontentstring否为空synTimeLong是同步时间戳，用于验证Macstring是Mac地址返回参数不需要任何返回，如果未同步了，可以通过 getAgentInfo 接口重新获取失败的数据
