惠州市电子公文交换系统接口规范 - 惠州市电子公文交换系统接口规范.doc

惠州市电子公文交换系统接口规范1login32Initialize33logout44GetOrganList45GetCatalogList66GetFieldList87GetSecretList108GetDomainList129GetDocumentCount1310GetDocumentIDs1311GetDocumentInfo1412GetFile1913GetSignFile2014ReplyOKToDocument2015SaveDocumentStatus2016SendReject2117SendReceipt2218SendFile2219SendSignFile2320SendDocument2321SendCallback2822SendCallbackByID2823SendUrgency2924GetMessageCount2925GetMessageIDs3026GetMessageInfo3027ReplyOKToMessage3328SaveMessageStatus3329GetBroadcastCount3330GetBroadcastIDs3431GetBroadcastInfo3432ReplyOKToBroadcast3633SaveBroadcastStatus3634ChangeOrganInfo3735ChangePassword3736ChangeUserInfo381 login原型:Sub Login(UserName As String, Password As String)功能:用户登录参数:UID：用户帐号PWD：用户密码返回:无2 Initialize原型:Function Initialize() as Variant功能:获取用户初始化信息返回:XML字符串，用户的基本信息，由以下的XML Schema定义初始化获取当前用户的基本信息用户编号用户姓名机构编号机构名称机构域名服务器唯一标识服务器域名用户手机号3 logout原型:Sub Logout()功能:退出系统4 GetOrganList 原型：Function GetOrganList(Date as Variant) As Variant功能取最新更新后机构列表，本地要跟踪最后请求时间，以便下次就可以只取更新记录参数Date:最后获取时间返回由下列XML Schema .定义的XML字符串获取最新的更新后机构列表返回最近获取时间机构列表机构编号上级机构编号机构全称机构简称机构域名排列顺序层次创办时间停办时间机构简介5 GetCatalogList 原型Function GetCatalogList(Date as Variant) As Variant功能获取最新文种列表，本地要跟踪最后请求时间，以便下次就可以只取更新记录参数Date:最后获取时间返回由下列XML Schema所定义的XML字符串获取最新的更新文种列表返回最近获取时间分类列表分类编号机构编号分类名称分类简称备注要素列表要素编号要素名称6 GetFieldList 原型Function GetFieldList(Date As Variant) As Variant功能获取最新要素，本地要跟踪最后请求时间，以便下次就可以只取更新记录参数Date:最后获取时间返回返回由下列XML Schema所定义的XML字符串获取最新的要素列表最后的获取时间要素列表要素编号要素类型要素英文名称要素中文名称长度小数点是否为空7 GetSecretList 原型 Function GetScrectList(Date As Variant) As Variant参数 Date:最后获取时间功能获取最新密级列表，本地要跟踪最后请求时间，以便下次就可以只取更新记录返回返回下列XML Schema所定义的XML字符串获取最新的更新密级列表最后获取时间密级列表密级编号密级名称保管期限描述8 GetDomainList原型Function GetDomainList(Date As Variant) As Variant功能 获取更新后的域名信息参数Date:最后获取时间返回返回由下列XML Schema所定义的XML字符串获取最新的更新域名列表最后获取时间机构编号父机构编号机构名称机构域名服务器编号服务器域名9 GetDocumentCount原型 Function GetDocumentCount() As Variant功能 获取未收取的公文的数目返回 变体变量，未收取的公文的数目10 GetDocumentIDs 原型 Function GetDocumentIDs(Number As Long) As Variant功能 获取最新未收取公文的交换序号列表参数 Number:预获取个数返回 由下图的XML Schema定义的字符串最新公文的交换序号列表公文的交换序号 11 GetDocumentInfo原型 Function GetDocumentInfo(DocumentID As Long) As Variant功能获取公文详细内容参数 DocumentID：公文的交换序列号返回由下列XML Schema定义的字符串 公文详细信息 机构编号 机构域名 机构名称 服务器编号 服务器域名 机构编号 机构域名 机构名称 服务器编号 服务器域名 接收类别 主送方列表 抄送方列表 文档序号 流