U8API开发手册(C#版) 下载本文

如果是外部事务,则需要传递ADO.Connection对象,并将IsIndependenceTransaction设置为true:

envContext.BizDbConnection = new ADO.Connection(); envContext.IsIndependenceTransaction = true;

3. 设置API地址标识(Url)参数

//如当前API“新增或修改”的地址标识为:U8API/SaleOrder/Save

U8ApiAddress myApiAddress = new U8ApiAddress(\

4. 构造APIBroker

U8ApiBroker broker = new U8ApiBroker(myApiAddress, envContext);

5. API对象参数赋值

1) 给BO表头参数DomHead和表体参数domBody赋值有两种方法,如下: 方法一是直接传入MSXML2.DOMDocumentClass对象,代码如下

MSXML2.DOMDocumentClass domHead = new MSXML2.DOMDocumentClass(); domHead.load(\);

broker.AssignNormalValue(\, domHead);

方法二是构造BusinessObject对象,具体方法如下:

//首先通过GetBoParam方法获取表头表体参数

注意:设置行数为某个值,行数并不限定为该最大值,可以一直顺序添加至任意行,但有一个规则:例如当设置为10时,可以对第0、1、??9行赋值,当对第10行赋值时候,则会顺序添加一个新行,但此时是不能对第11行赋值的,当添加一个新行(第10行)后,又可以对第11行进行赋值。

/****************************** 以下是必输字段 ****************************/ domHead[0][\主关键字段,int类型 domHead[0][\订 单 号,string类型 domHead[0][\订单日期,DateTime类型 domHead[0][\业务类型,string类型 ??

/***************************** 以下是非必输字段 ****************************/ domHead[0][\现存件数,double类型 BusinessObject DomHead = broker.GetBoParam(\DomHead.RowCount = 10; //设置行数

//其中,给BO对象的字段赋值,值可以是真实类型,也可以是无类型字符串 //以下代码示例只设置第一行值。各字段定义详见API服务接口定义

domHead[0][\可用件数,double类型 domHead[0][\预发货日期,DateTime类型 domHead[0][\预完工日期,DateTime类型 domHead[0][\预发货日期,DateTime类型

??

2) 给普通参数赋值 例如,

//给普通参数VoucherState(参数名)赋值。此参数的数据类型为int,此参数按值传递,具体请参考服务接口定义

broker.AssignNormalValue(\ 注意:所有参数名不限大小写。

3) 给“OUT型”参数赋值

为方便用户使用U8API,如果参数数据类型为一般值类型,如String、Integer、Long、Single、Double、Boolean、Date,则不必传入一个参数变量(传入也可);否则,则必须一个参数变量。

如: ??

//该参数curID为OUT型参数,由于其数据类型为string,为一般值类型,因此不必传入一个参数变量。在API调用返回时,可以通过GetResult(\获取其值

//该参数CurDom为OUT型参数,由于其数据类型为MSXML2.IXMLDOMDocument2,非一般值类型,因此必

须传入一个参数变量。在API调用返回时,可以直接使用该参数

MSXML2.IXMLDOMDocument2 CurDom = new MSXML2.IXMLDOMDocument2(); broker.AssignNormalValue(\

??

当不传入一个参数变量时,在API调用返回时,可以通过GetResult(参数名)获取其值;当不必传入一个参数变量时,在API调用返回时,可以直接引用该参数。

4) 给“INOUT型”参数赋值 对“INOUT型”型参数,则不论是否是一般值类型,都需要传入参数变量。其他与“OUT型”参数一样。

6. 调用API

//示例调用如下:

if (!broker.Invoke())

{

//错误处理

Exception apiEx = broker.GetException(); if (apiEx != null) {

if (apiEx is MomSysException)

}

}

{ }

else if (apiEx is MomBizException) { }

MomBizException bizEx = apiEx as MomBizException; Console.WriteLine(\异常:\//todo:异常处理

MomSysException sysEx = apiEx as MomSysException; Console.WriteLine(\系统异常:\//todo:异常处理

//结束本次调用,释放API资源 broker.Release(); return;

注意:对调用失败,可以获取出错信息,如果是API框架的原因,则报告MomSysException异常,如果是业务组件的原因,则报告MomBizException异常。

7. 获取返回结果

1) 获取BO对象

在“装载单据”时,通过GetBoParam方法获取表头或表体参数

BusinessObject DomHeadRet = broker.GetBoParam(\

Console.WriteLine(\对象行数为:\获取BO对象的行数 如果要取原始的XMLDOM对象结果,请使用GetResult(\MSXML2.DOMDocument DomHeadRet = broker. GetResult(\以上获取的行数是BO对象的实际行数。

//获取BO对象各字段的值。以下代码示例只取第一行。字段定义详见API服务接口定义

/****************************** 以下是必输字段 ****************************/ int id = Convert.ToInt32(domHeadRet[0][\主关键字段,int类型

string ccode = Convert.ToString(domHeadRet[0][\单据号,string类型 DateTime ddate = Convert.ToDateTime(domHeadRet[0][\日期,DateTime类型 string cbustype = Convert.ToString(domHeadRet[0][\业务类型,string类型 ??

/***************************** 以下是非必输字段 ****************************/ string cpayname = Convert.ToString(domHeadRet[0][\付款条件,string类型 string cpersonname = Convert.ToString(domHeadRet[0][\业 务 员,string类型 double itaxrate = Convert.ToDouble(domHeadRet[0][\税率,double类型 string cexch_name = Convert.ToString(domHeadRet[0][\币种,string类型 ??

注意:

2)

获取普通返回值

代码如下:

//获取普通返回值。此返回值数据类型为System.String,此参数按值传递,具体请参考服务接口定义 System.String result = broker.GetReturnValue() as System.String; 3)

获取普通“OUT型”或“INOUT型”返回值

如前所述,对普通“OUT型”或“INOUT型”参数,如果是一般值类型,则通过GetResult方法获取其返回值,否则直接使用该引用。

如,

//获取普通OUT参数curID。此返回值数据类型为string,在使用该参数之前,请判断是否为空 string curIDRet = broker.GetResult(\

//获取普通OUT参数CurDom。此返回值数据类型为MSXML2.IXMLDOMDocument2,前面已定义该参数,请直接使用 ??