欢迎!这里是飞印API文档

飞印API文档描述、示例


查询打印异常

简要描述:

  • 无线移动网络或停电的外部因素可以导致飞印无线打印机打印失败。每当这类事故发生时,飞印API将对失败的打印请求生成异常日志。用户可以用查询打印异常的API功能来查询相关异常信息,方便诊断问题和解决问题。

  • 每当收到查询打印异常的请求时,飞印API将根据用户指定的时间段(默认是最后10天)内、用户所拥有的所有飞印打印机的打印异常,并返回XML格式的异常日志信息。

请求URL:

  • http://my.feyin.net/api/listException

请求方式:

  • 查询打印异常的请求及其参数须采用HTTP GET发送给飞印API。

参数:

用于查询打印异常的请求须包含以下参数(粗体部分为必填):

reqTime :请求(发生)时间戳,数值型 本次API请求发生的时刻,值为自 1970-1-1 0:0 到现在的 毫秒数 类似于Java语言中的 System.currentTimeMillis() 函数的取值。

securityCode :安全校验码,字符串 调用飞印API的网站/应用系统用 API_KEY 针对请求内容生成的MD5哈希字串,此字串将被飞印API用于请求有效性的验证。 请参考 使用前的准备 了解如何获取 API_KEY 。

memberCode :商户编码,数值型 您在 飞印中心 注册的帐号对应的(系统自动生成的)商户编码,可登录飞印中心按指引获取。

start :查询的开始日期,日期字符串 用 yyyy-MM-dd 格式。例如: 2010-09-03 是指 2010年9月3日 。如此参数留空,默认为最近10天。

end :查询的截至日期,日期字符串 用 yyyy-MM-dd 格式。例如: 2010-09-03` 是指 2010年9月3日 。如此参数留空,默认为今天。


返回示例

XML字符串 :查询打印异常日期的请求返回XML格式的信息,例如:

<?xml version="1.0" encoding="UTF-8"?>
<exceptionList begin="2010-10-08" end="2010-10-18">
  <exception>
    <msgNo>12873947857</msgNo>
    <msgTime>2010-10-18 17:39</msgTime>
    <customer><![CDATA[  Name: Ms Liu,Phone: 13321332245, Add: SCUT
            North Campus, Notes: Please hurry up. ]]> </customer>
    <detail>
    <![CDATA[
    Fried noodle-1000-1 Fried chicken legs-2000-1
    ]]>
    </detail>
  </exception>

  <exception>
    <msgNo>12873945227</msgNo>
    <msgTime>2010-10-18 17:35</msgTime>
    <customer><![CDATA[  ]]> </customer>
    <detail><![CDATA[
    This is free-form print data. Please limit your text within 4KB in size
    in each print request you send.]]>
    </detail>
  </exception>
</exceptionList>

begin 和 end 用来指定查询打印异常发生的时间段。它们都是日期字符串,格式为 YYYY-MM-DD 。

msgNo 是用户(API调用网站/系统)自行指定的打印请求编号。

msgTime 是指请求发生的时间。

customer 是指客户信息(只用于格式化打印请求)。

detail 是打印请求的数据/内容。

返回参数说明

查询打印异常信息功能可返回以下状态码:

-1 :IP地址不允许

-2 :关键参数为空或请求方式不对

-3 :客户编码不正确

-4 :安全校验码不正确

-5 :请求时间失效。请求时间和请求到达飞印API的时间长超出安全范围。请参考 同步应用服务器时间 了解更多飞印API的时间安全设置。

备注

  • 更多例子请看飞印官网的实例代码描述
  • 测试查询打印异常

您可通过 testListException() 这个方法测试查询打印异常功能。请参考 飞印API集成示例代码 中的示例代码了解具体的使用。

页面列表

ITEM_HTML