-webservice接口说明书.doc

CMD之webservice接口说明书拟制日期审核日期批准日期修订历史记录版本日期AMD修订者说明V1.02016-8-17A马勇成第一版1 接口综述l 接口链接类似：9:8080/cmd/api/v1/me/waybill/orderl 以上9:8080是测试环境，生产请用http:/ 1:8080或http:/ 2:8080l 参数传递方式：GET/POST方式（暂不提供PUT和DELETE方式）l 加密压缩规则：不加密，压缩和解压由CXF框架完成l 编码格式：UTF-82 网络访问关系访问CMD接口需开通以下网络访问关系：环境WebService生产1:80802:8080测试9:80803 接口列表3.1 进口运单读取3.1.1 接口简介l 根据开始发运日期和结束发运日期来查询材料信息。l 接口示例：l 接口链接类似：9:8080/cmd/api/v1/me/waybill/order3.1.2 请求参数l Key-Value键值对的形式传入l 参数说明序号参数名可空？说明1shipDateN开始运单时间（yyyy-MM-dd）2ShipDateN结束运单时间（yyyy-MM-dd）3.1.3 使用说明l 如示例中9:8080/cmd/api/v1/me/waybill/order是接口在服务器端的目录，问号后面带传入的参数，参数形式startDate=？&endDate=?以上9:8080是测试环境，生产请用http:/ 1:8080或http:/ 2:80803.1.4 返回格式Json格式3.1.5 返回结果结果集字段说明表l 参数名字段类型NULL?说明运单号StringN包装类型stringN毛重doubleN大于0的数字（包括小数）运单附件IDstringN利用此可查看上传的附件。航班号stringY运费stringN大于0的数字（包括小数）币种stringN承运人stringN发运日期stringN精确到天，yyyy-MM-dd备注stringN最后更新日期stringN精确到天，yyyy-MM-dd hh24:mi运单航材基本信息参数名字段类型NULL?说明运单号StringN合同号StringN件号stringN到货数量intN大于0的整数总净重doubleN大于0的数字（包括小数）,单位是KG申报币种stringN总申报价值doubleN非负数字（包括小数和0）l 返回结果示例weight:111.0,orderNo:111,flightNo:11,orderMaterialDto:,attachmentId:84/roNo/downLoadDocument.do?fileId=0901ccf8800ed090&fileName=SupplierPrice_20150623161209.pdf&supplierno=GOODRD&fileSize=9138,remark:机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部,userId:8ad9f138549e78100154a4055cec0061,freight:11.0,packType:wooden,lastModifyDate:2016-07-08 10:57,shipDate:2016-07-08,currencyType:USD,weight:666.0,orderNo:555,flightNo:666,orderMaterialDto:orderNo:555,totalWeight:110.0,contractNo:027020534,arriverGoodsNum:5,pieceNo:341261A44R01,currencyType:US,totalPrice:0.0,attachmentId:84/roNo/downLoadDocument.do?fileId=0901ccf8800ec9cf&fileName=%25E5%258D%2597%25E8%2588%25AA%25E8%25BF%2590%25E4%25BB%25A3.pdf&supplierno=GOODRD&fileSize=78559,remark:wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww,userId:8ad9f138549e78100154a4055cec0061,freight:666.0,packType:other,lastModifyDate:2016-08-17 10:17,shipDate:2016-07-26,currencyType:CNY,weight:1.0,orderNo:999-44234352,flightNo:null,orderMaterialDto:orderNo:999-44234352,totalWeight:0.0,contractNo:R14011554,arriverGoodsNum:1,pieceNo:018550-000,currencyType:RM,totalPrice:0.0,attachmentId:84/roNo/downLoadDocument.do?fileId=0901ccf8800ec9ce&fileName=%25E5%259C%25A8MyEclipse%25E4%25B8%25AD%25E4%25BD%25BF%25E7%2594%25A8ant.pdf&supplierno=Leader&fileSize=243435,remark:null,userId:8ad9f13855a479b50155be41defb0064,freight:200.0,packType:paper,lastModifyDate:2016-07-06 15:24,shipDate:2016-07-07,currencyType:USD,weight:1.0,orderNo:1234,flightNo:111,orderMaterialDto:orderNo:1234,totalWeight:0.0,contractNo:R13051057,arriverGoodsNum:1,pieceNo:6277<script>alert(1)</script>3-304MOD2,currencyType:RM,totalPrice:0.0,orderNo:1234,totalWeight:2.0,contractNo:R13063107,arriverGoodsNum:1,pieceNo:0154JU,currencyType:US,totalPrice:0.0,attachmentId:84/roNo/downLoadDocument.do?fileId=0901ccf8800ed08f&fileName=SupplierPrice_20150623153414.pdf&supplierno=GOODRD&fileSize=20505,remark:null,userId:8ad9f138549e78100154a4055cec0061,freight:123.0,packType:wooden,lastModifyDate:2016-07-08 10:54,shipDate:2016-07-08,currencyType:EUR,weight:22334.0,orderNo:ffddfff,flightNo:null,orderMaterialDto:orderNo:ffddfff,totalWeight:0.5,contractNo:R14008898,arriverGoodsNum:1,pieceNo:0102ME2GE,currencyType:US,totalPrice:989.53,orderNo:ffddfff,totalWeight:2.0,contractNo:R13063109,arriverGoodsNum:1,pieceNo:WW,currencyType:US,totalPrice:4722.87,orderNo:ffddfff,totalWeight:0.0,contractNo:X14100535,arriverGoodsNum:1,pieceNo:7001330H03,currencyType:US,totalPrice:0.0,orderNo:ffddfff,totalWeight:0.0,contractNo:X14100535,arriverGoodsNum:1,pieceNo:7001330H03,currencyType:US,totalPrice:0.0,orderNo:ffddfff,totalWeight:0.0,contractNo:X14100535,arriverGoodsNum:1,pieceNo:7001330H03,currencyType:US,totalPrice:0.0,attachmentId:84/roNo/downLoadDocument.do?fileId=0901ccf8800ec9cd&fileName=11.pdf&supplierno=Leader&fileSize=149449,remark:null,userId:8ad9f13855a479b50155be41defb0064,freight:2234.0,packType:wooden,lastModifyDate:2016-07-06 15:13,shipDate:2016-07-14,currencyType:USD,weight:14.0,orderNo:297-60131820,flightNo:null,orderMaterialDto:orderNo:297-60131820,totalWeight:0.5,contractNo:130207432,arriverGoodsNum:10,pieceNo:11-6557-5A,currencyType:US,totalPrice:85.15,attachmentId:84/roNo/downLo