[TOC]
# 一. 文档背景
EAS各个业务模块需要用到影像，金蝶EAS和影像系统集成是EAS共享平台统一跟外部系统对接
# 二. 文档目的
此文档旨在让各业务模块、EAS二开团队了解EAS共享平台影像相关功能设计和接口
# 三. EAS影像服务提供给业务模块接口文档(内部接口)
>以下接口提供给EAS内部业务模块、EAS二开人员使用
---
## 1. 查看影像
>一般业务人员在审核单据的时候，需要核对报销人员所提交的影像信息，此时EAS需要调用此接口。
1.1 接口定义
```
/**
* @param ctx 上下文
* @param billID 需要查看影像的单据id；Required
* @param isAllowRescan 是否允许退扫影像；true表示可以退扫、false表示不允许退扫影像；默认不允许退扫影像
* @param isApp 是否移动端调用；true表示移动端调用、false表示PC端调用；默认PC端调用
*/
public String getImageURL(String billID, boolean isAllowRescan, boolean isApp) throws BOSException, EASBizException
```
1.2 调用代码示例
```
String imageURL = BillImageFacadeFactory.getLocalInstance(ctx).getImageURL("单据id",false,false);
```
1.3 注意事项
```
1:导入代码包需要导入com.kingdee.eas.base.wssc下的包
2:此接口未发布对外api
```
---
## 2. 生成影像编码(指定单据id)
>推荐使用此接口；业务单据如果需要用到影像，需要调用EAS生成影像编码接口；生成的影像编码是跟影像系统交互的唯一标识；影像编码生成规：影像前缀 + 单据bosType前缀 + 单据编码
2.1 接口定义
```
/**
* @param ctx 上下文
* @param bosType 单据实体bostype；可以传空字符串
* @param billID 单据id；Required
*/
public String getImageNumber(String bosType, String billID) throws BOSException
```
2.2 调用代码示例
```
String imageNumber = BillImageFacadeFactory.getLocalInstance(ctx).getImageNumber("单据实体bostype","单据id");
```
2.3 注意事项
```
1:导入代码包需要导入com.kingdee.eas.base.wssc下的包
2:此接口存在多个重载方法，调用时请注意区分
```
---
## 3. 生成影像编码(指定单据id、指定单据的编码)
>无特殊需求，不推荐使用此接口；影像编码生成规则：影像前缀 + 单据bosType + 指定的单据编码；用户使用此接口可以指定一个影像编码，那么这个影像编码将是有这个单据编码组成的；一般可以应用在一些单据编码不唯一，通过自定义规则生成一个唯一单据编码的情况。
3.1 接口定义
```
/**
* @param ctx 上下文
* @param billID 单据id；Required；
* @param billNumber 指定的单据编码；如果传空，跟2接口无区别
*/
public String getImageNumber(String bosType, String billID, String billNumber) throws BOSException
```
3.2 代码调用示例
```
String imageNumber = BillImageFacadeFactory.getLocalInstance(ctx).getImageNumber("单据实体bostype","单据id","单据编码");
```
3.3 注意事项
```
1:导入代码包需要导入com.kingdee.eas.base.wssc下的包
2:此接口存在多个重载方法，调用时请注意区分
```
---
## 4. 生成影像编码(苍穹同步单据到EAS业务场景)
>此接口专为苍穹苍穹业务单据同步到EAS，EAS再调用共享平台生成影像编码而设计的接口
4.1 接口定义
```
/**
* @param ctx 上下文
* @param bosType 单据实体bostype；
* @param easBilllId EAS业务单据id；Required；
* @param extendBillID 外部系统单据id；Required；
* @param imageNo 影像编码；
*/
public String getImageNumber(String bosType, String easBillId, String extendName, String extendBillID, String imageNo) throws BOSException, EASBizException
```
4.2 代码调用示例
```
String imageNumber = BillImageFacadeFactory.getLocalInstance(ctx).getImageNumber("单据实体bostype","eas单据id","苍穹单据id","影像编码");
```
4.3 注意事项
```
1:导入代码包需要导入com.kingdee.eas.base.wssc下的包
2:此接口存在多个重载方法，调用时请注意区分
3:此接口在EAS8.5及高版本才有此功能
```
---
## 5. 退扫影像(指定单据、指定退扫人、退扫原因)
>退扫影像一般用在工作流节点上；比如单据审批的过程中，发现影像有问题，此时可以选择一个打回单据并打回影像的流程；那么打回影像就是调用此接口
5.1 接口定义
```
/**
* @param billID 单据id；Required
* @param operateID 操作人员id(t_pm_user表的fid字段)；Required
* @param reScanMsg 退扫原因；
* @return 成功则返回1；否则返回0
*/
public String imageRescan(BOSUuid billID, String operateID, String reScanMsg) throws BOSException, EASBizException
```
5.2 代码调用示例
```
String imageNumber = BillImageFacadeFactory.getLocalInstance(ctx).imageRescan("单据id","操作人员id","退扫原因");
```
5.3 注意事项
```
1:导入代码包需要导入com.kingdee.eas.base.wssc下的包
2:此接口存在多个重载方法，调用时请注意区分
```
---
## 6. ~~退扫影像(指定单据)~~
>此接口只能退扫指定的单据，无法传入退扫原因等，此接口在高版本已经不被推荐使用；使用请谨慎。
6.1 接口定义
```
/**
* @param ctx 上下文
* @param billID 单据id；Required
* @return 成功则返回1；否则返回0
*/
public String imageRescan(String billID) throws BOSException
```
6.2 调用代码示例
```
String result = BillImageFacadeFactory.getLocalInstance(ctx).imageRescan("单据id");
```
6.3 注意事项
```
略
```
---
## 7. ~~删除影像(指定单据)~~
>删除影像一般使用在单据删除或者废弃的时候，需要删除曾经上传过的影像，那么可以调用此接口；
7.1 接口定义
```
/**
* @param ctx 上下文
* @param billID 单据id；Required
* @param isImageSystem 是否使用影像
*/
public void deleteSSCAndImageDataByBillID(String billID, boolean isImageSystem) throws BOSException
```
7.2 调用代码示例
```
BillImageFacadeFactory.getLocalInstance(ctx).deleteSSCAndImageDataByBillID("单据id",true);
```
7.3 注意事项
```
1:此接口一般提供给业务单据代码调用
2:此接口第二个参数一般传true
```
---
## 8. 删除影像(指定单据、指定需要删除的数据)
>此接口一般提供给工作流使用
8.1 接口定义
```
/**
* @param billId 单据ID
* @param isDeleteImageMsg 是否删除影像系统信息
* @param isDeleteSscMsg 是否删除共享平台系统信息
* @param isDeleteImageMapMsg 是否删除影像映射表信息
*/
public void deleteRefInfoByBillID(String billId, boolean isDeleteImageMsg, boolean isDeleteSscMsg, boolean isDeleteImageMapMsg) throws BOSException
```
8.2 调用示例
```
BillImageFacadeFactory.getLocalInstance(ctx).deleteRefInfoByBillID("单据id",true,true,true);
```
8.3 注意事项
```
1:isDeleteImageMsg 如果用到了影像系统，那么这个参数传true
2:isDeleteSscMsg 如果用到了财务共享平台，这个参数传true
3:isDeleteImageMapMsg 如果需要删除影像映射表，这个参数传true
```
---
# 四. EAS提供给影像系统接口文档
>以下接口提供给影像系统、第三方影像系统接入、二开影像系统使用
---
## 1. 获取影像票据信息接口
>道可维斯、国信、发票云使用此接口
1.1 接口概览
类目 | 说明
---|---
接口类型 | webservice
接口名称 | getImageInfo
wsdl地址 | http://ip:port/ormrpc/services/WSSSCImageBaseServiceFacade?wsdl
请求参数 | string
返回值 | String
1.2 接口定义
```
public String getImageInfo(String inputXml) throws BOSException, EASBizException
```
1.3 接口参数示例
```
<?xml version="1.0" encoding="UTF-8" ?><ImageList><Image imageNo="BXD202211151337001" billNo=""/></ImageList>
```
1.4 接口参数描述
字段名称 | 字段类型 | 字段说明 | 是否必输
-|-|-|-
imageNo | String | 影像编码 | 是
billNo | String | 单据id | 否
1.5 接口返回值示例
```
<?xml version="1.0" encoding="UTF-8" ?><ImageList><Image imageNo="BXD202211151337001" billNo="" imageAllowScan="AllowScan" imageExists="Exists" billStatus="" billAmount="" imageStatus="" imageLocationNo="" applierCompany="SY25" creatorId="6lc8uLMUSc+HEIcN52/cpRO33n8=" creatorName="XXX" creatorPhone="12345678898" creatorEmail="" number="202211151337001" resource="2" /></ImageList>
```
1.6 接口返回值描述
字段名称 | 字段类型 | 字段说明
-|-|-|
imageNo | String | 影像编码
billNo | String | 单据id
billBosType | String | 单据bosType
billTypeName | String | 单据类型名称
imageAllowScan | String | 是否允许退扫
imageExists | String | 影像是否存在
billAmount | String | 金额
imageStatus | String | 影像状态
imageLocationNo | String |
applierCompany | String | 申请人公司编码
applierCompanyName | String | 申请人公司名称
creatorId | String | 制单人id
creatorNumber | String | 制单人编码
creatorName | String | 制单人名称
creatorPhone | String | 制单人手机
creatorEmail | String | 制单人电子邮件
number | String | 单据编码
resource | String | 来源，目前发票云影像系统使用该字段，传的值是2
---
## 2. 上传影像
>道可维斯、国信、发票云使用此接口
2.1 接口概览
类目 | 说明
---|---
接口类型 | webservice
接口名称 | imageReady
wsdl地址 | http://ip:port/ormrpc/services/WSSSCImageBaseServiceFacade?wsdl
请求参数 | string
返回值 | String
2.2 接口定义
```
public String imageReady(String inputXml) throws BOSException, EASBizException
```
2.3 接口参数示例
```
<?xml version="1.0" encoding="UTF-8"?><ImageList><Image imageNo= "KDQQ-KDC-02-20221027-10965" billNo= "" sscUnit="" resCanType="" scanUserID="" scanTime="" pageCount="" scanClientIP=""/></ImageList>
```
2.4 接口参数描述
字段名称 | 字段类型 | 字段说明 | 是否必输
-|-|-|-
imageNo | String | 影像编码 | 是
billNo | String | 单据id | 否
sscUnit | String | 扫描点 | 否
resCanType | String | 扫描类型 | 否
scanUserID | String | 扫描人 | 否
scanTime | String | 扫描时间 | 否
pageCount | String | 影像张数 | 否
scanClientIP | String | 扫描ip地址 | 否
2.5 接口返回值示例
```
略
```
2.6 接口返回值描述
```
上传影像成功则返回影像编码；失败EAS会抛出异常
```
---
## 3. 退扫影像
>道可维斯、国信、发票云使用此接口
3.1 接口概览
类目 | 说明
---|---
接口类型 | webservice
接口名称 | updateImagestate
wsdl地址 | http://ip:port/ormrpc/services/WSSSCImageBaseServiceFacade?wsdl
请求参数 | string
返回值 | void
3.2 接口定义
```
public void updateImageState(String inputXml) throws BOSException, EASBizException
```
3.3 接口参数示例
```
<?xml version="1.0" encoding="UTF-8"?><ImageList><Image imageNo= "KDQQ-KDC-02-20221027-10965" billNo= "" state="" sscType="" rescanMessage="" scanUserID="" message=""/></ImageList>
```
3.4 接口参数描述
字段名称 | 字段类型 | 字段说明 | 是否必输
-|-|-|-
imageNo | String | 影像编码 | 是
billNo | String | 单据id | 否
state | String | 影像状态；"0"或者"1":无影像；"2":有影像；"3":退扫；"4":影像重传 | 是
sscType | String | | 否
scanUserID | String | 扫描人 | 是
rescanMessage | String | 退扫原因 | 否
message | String | 退扫原因 | 否
3.5 接口返回值示例
```
无
```
3.6 接口返回值描述
```
无
```
---
## 4. 更新影像状态
>天创证腾影像系统使用(上传影像和退扫影像)
4.1 接口概览
类目 | 说明
---|---
接口类型 | webservice
接口名称 | updateImagestateNew
wsdl地址 | http://ip:port/ormrpc/services/WSSSCImageBaseServiceFacade?wsdl
请求参数 | string
返回值 | string
4.2 接口定义
```
public String updateImageStateNew(String inputXML) throws BOSException, EASBizException
```
4.3 接口参数示例
```
<?xml version="1.0" encoding="UTF-8"?><DATA><barCodeList><barCode>KDQQ-KDC-02-20221027-10965</barCode><imageCount></imageCount></barCodeList><imageState></imageState><updaterID></updaterID><updReason></updReason></DATA>
```
4.4 接口参数描述
字段名称 | 字段类型 | 字段说明 | 是否必输
-|-|-|-
barCode | String | 影像编码 | 是
imageCount | String | 影像张数 | 否
imageState | String | 影像状态 | 是
updaterID | String | 操作人员 | 是
updReason | String | 操作原因 | 是
4.5 接口返回值示例
```
<?xml version="1.0" encoding="UTF-8"?><DATA><retCode></retCode><!—返回信息码--><retMsg></retMsg><!—返回信息--></DATA>
```
4.6 接口返回值描述
字段名称 | 字段类型 | 字段说明
-|-|-
retCode | String | 返回信息码；0:操作成功；1:操作失败
retMsg | String | 返回信息；成功：success；失败：失败原因
---
## 5. 同步用户
>目前使用该接口有
> 1:天创影像系统；
> 2:国信档案系统；
5.1 接口概览
类目 | 说明
---|---
接口类型 | webservice
接口名称 | snchronyUser
wsdl地址 | http://ip:port/ormrpc/services/WSSSCImageBaseServiceFacade?wsdl
请求参数 | string
返回值 | string
5.2 接口定义
```
public String snchronyUser(String inputXML) throws BOSException, EASBizException
```
5.3 接口参数示例
```
<?xml version="1.0" encoding="UTF-8"?><DATA>< beginTime>< beginTime>< endTime >< endTime ></DATA>
```
5.4 接口参数描述
字段名称 | 字段类型 | 字段说明 | 是否必输
-|-|-|-
beginTime | String | 获取某个时间段t_pm_user新增的用户；不传表示获取所有用户 | 否
endTime | String | 获取某个时间段t_pm_user新增的用户；不传表示获取所有用户 | 否
5.5 接口返回值示例
```
[{"userID":"用户id","userNumber":"用户编码","userName":"用户名","personID":"职员用户id","orgID":"组织id"}]
```
5.6 接口返回值描述
字段名称 | 字段类型 | 字段说明
-|-|-
userID | String | 用户id
userNumber | String | 用户编码
userName | String | 用户名称
personID | String | 职员用户id
orgID | String | 组织id
---
## 6. 同步组织
>目前使用该接口有
> 1:天创影像系统；
> 2:国信档案系统；
6.1 接口概览
类目 | 说明
---|---
接口类型 | webservice
接口名称 | snchronyOrg
wsdl地址 | http://ip:port/ormrpc/services/WSSSCImageBaseServiceFacade?wsdl
请求参数 | string
返回值 | string
6.2 接口定义
```
public String snchronyOrg(String inputXML) throws BOSException, EASBizException
```
6.3 接口参数示例
```
<?xml version="1.0" encoding="UTF-8"?><DATA>< beginTime>< beginTime>< endTime >< endTime ></DATA>
```
6.4 接口参数描述
字段名称 | 字段类型 | 字段说明 | 是否必输
-|-|-|-
beginTime | String | 获取某个时间段t_org_baseunit新增的组织；不传表示获取所有组织 | 否
endTime | String | 获取某个时间段t_org_baseunit新增的组织；不传表示获取所有组织 | 否
6.5 接口返回值示例
```
[{"orgID":"组织id","orgNumber":"组织编码","orgName":"组织名","isLeaf":"是否叶子结点","level":"组织级次","parentID":"上级组织id"}]
```
6.6 接口返回值描述
字段名称 | 字段类型 | 字段说明
-|-|-
orgID | String | 组织id
orgNumber | String | 组织编码
orgName | String | 组织名称
isLeaf | String | 是否叶子结点
level | String | 组组织级次
parentID | String | 上级组织id
---
## 7. 生成影像编码
>该接口是提供给外部系统调用eas生成影像编码接口
>此接口目前标准产品没有用到，应该是提供给二开业务场景使用
7.1 接口概览
类目 | 说明
---|---
接口类型 | webservice
接口名称 | getImageNumberForErp
wsdl地址 | http://ip:port/ormrpc/services/WSSSCImageBaseServiceFacade?wsdl
请求参数 | string ｜ string
返回值 | string
7.2 接口定义
```
public String getImageNumberForErp(String billTypeCode, String billNumber) throws BOSException, EASBizException
```
7.3 接口参数示例
```
略
```
7.4 接口参数描述
字段名称 | 字段类型 | 字段说明 | 是否必输
-|-|-|-
billTypeCode | String | 单据类型简码 | 否
billNumber | String | 单据编码 | 是
7.5 接口返回值示例
```
略
```
7.6 接口返回值描述
>接口返回的是在eas生成的影像编码
---
## 8. 获取影像查看链接
>该接口是提供给外部系统调用eas获取查看影像链接接口
8.1 接口概览
类目 | 说明
---|---
接口类型 | webservice
接口名称 | getImageUrl
wsdl地址 | http://ip:port/ormrpc/services/WSSSCImageBaseServiceFacade?wsdl
请求参数 | string
返回值 | string
8.2 接口定义
```
public String getImageUrl(String imageNumber) throws BOSException, EASBizException
```
8.3 接口参数示例
```
略
```
8.4 接口参数描述
字段名称 | 字段类型 | 字段说明 | 是否必输
-|-|-|-
imageNumber | String | 影像编码 | 是
8.5 接口返回值示例
```
http://ip:port/xxx/xxx 或者是 https://ip:port/xxx/xxx
```
8.6 接口返回值描述
```
略
```
---
## 9. 获取影像状态接口
>该接口是提供给外部系统调用eas获取查看影像链接接口
9.1 接口概览
类目 | 说明
---|---
接口类型 | webservice
接口名称 | getImageState
wsdl地址 | http://ip:port/ormrpc/services/WSSSCImageBaseServiceFacade?wsdl
请求参数 | string
返回值 | string
9.2 接口定义
```
public String getImageState(String imageNumber) throws BOSException, EASBizException
```
9.3 接口参数示例
```
略
```
9.4 接口参数描述
字段名称 | 字段类型 | 字段说明 | 是否必输
-|-|-|-
imageNumber | String | 影像编码 | 是
9.5 接口返回值示例
```
略
```
9.6 接口返回值描述
字段名称 | 字段类型 | 字段说明
-|-|-
imageState | String | 影像状态；0:无影像；1:影像上传中；2:有影像；3:退回重扫；4:影像重传
