EXP API设计
2017-06-28 本文已影响127人
sunshine_hao
测试网域名：http://dev.nbeport.com
快件
提交
- url:/exp/rest/decl/save
- method:post
- request:EXP_DECL对象，id为空新增，不为空其他更新
- response:EXP_DECL对象
获取
- url:/exp/rest/decl/get
- method:get
- request:id
- response:EXP_DECL对象
列表
- url:/exp/rest/decl/list
- method:get
- request:
- response:EXP_DECL对象列表
受理-主单
- url:/exp/rest/decl/Accept
- method:post
- request:id，例如：{"id":"xxx"}
- response:
退回-总单
- url:/exp/rest/decl/Return
- method:post
- request:{"id":"xxx","remark":"xxx"}
- response:
审核-主单
- url:/exp/rest/decl/Examine
- method:post
- request:id，例如：{"id":"xxx"}
- response:
查验接单-主单
- url:/exp/rest/decl/AcceptCheck
- method:post
- request:id，例如：{"id":"xxx"}
- response:
放行-主单
- url:/exp/rest/decl/Pass
- method:post
- request:id，例如：{"id":"xxx"}
- response:
归档-主单
- url:/exp/rest/decl/Filed
- method:post
- request:id，例如：{"id":"xxx"}
- response:
人工拦截-子单
- url:/exp/rest/decl/InterceptLgs
- method:post
- request:id，例如：{"id":"xxx"}
- response:
放行-子单
- url:/exp/rest/decl/PassLgs
- method:post
- request:id，例如：{"id":"xxx"}
- response:
查验结果登记-子单
- url:/exp/rest/decl/CheckLgs
- method:post
- request:ID,CHECK_FLG(2=查验合格，3=查验不合格),CHECK_REMARK,CHECK_REASON，CHECK_RESULT(技术处理=01,检疫处理=02,退运处理=03,销毁处理=04)
，例如：{"ID":"xxx","CHECK_FLG":"xxx","CHECK_REMARK":"xxx","CHECK_REASON":"xxx","CHECK_RESULT","xxx"} - response:
调回-子单
- url:/exp/rest/decl/BackLgs
- method:post
- request:{"id":"xxx"}
- response:
确认调回-总单
- url:/exp/rest/decl/ConfirmBackLgs
- method:post
- request:{"id":"xxx"}
- response:
批量通过-子单
- url:/exp/rest/decl/BatchPassLgs
- method:post
- request:["id1","id2","id3"]
- response:
平台端快件申报
- url:/exp/rest/decl/Register
- method:post
- request:主单、分单信息，如下例：{"DECL_NO":"11111","TOTAL_LGS_NO":"888888","LGS_COUNT":98.0,"TOTAL_COUNT":4.0,"TOTAL_WEIGHT":4.0,"FLIGHT_DATE":null,"DESP_CTRY":null,"ENTRY_PORT":null,"CARRIER_AVIATION":null,"DECL_ORG_CODE":null,"DECL_ORG_NAME":null,"WOODEN_PACKING":null,"PACKING_TYPE":null,"PACKING_QTY":null,"I_E_FLAG":"I","RE_DECL":"0","picList":[{"PIC_URL":"xxxx","PIC_NAME":"name1","PIC_TYPE":"type1"},{"PIC_URL":"xxxcxccx","PIC_NAME":"name2","PIC_TYPE":"type2"}],
"lgsList":[
{"LGS_NO":"111","QTY":null,"WEIGHT":null,"VAL_US":null,"PAY_WAY":null,"ORI_CTRY":null,"MODEL":null,"DECL_TYPE":null,"CONSIGNEE_NAME":null,"CONSIGNEE_ORG":null,"CONSIGNEE_COUNTRY":null,"CONSIGNEE_CITY":null,"CONSIGNEE_ADDR":null,"CONSIGNEE_POSTCODE":null,"CONSIGNEE_TEL":null,"CONSIGNOR_NAME":null,"CONSIGNOR_ORG":null,"CONSIGNOR_COUNTRY":null,"CONSIGNOR_CITY":null,"CONSIGNOR_ADDR":null,"CONSIGNOR_POSTCODE":null,"CONSIGNOR_TEL":null,"cargoList":[{"GOODS_NAME":"name1","HS_NUMBER":"hsnumber1","HS_CODE":"hscode1"},{"GOODS_NAME":"name2","HS_NUMBER":"hsnumber2","HS_CODE":"hscode2"}],"CARD_ID":"xxx","CARD_FILE":"xxx","picList":[{"PIC_URL":"xxxx","PIC_NAME":"name1","PIC_TYPE":"type1"},{"PIC_URL":"xxxcxccx","PIC_NAME":"name2","PIC_TYPE":"type2"}]},
{"LGS_NO":"222","QTY":null,"WEIGHT":null,"VAL_US":null,"PAY_WAY":null,"ORI_CTRY":null,"MODEL":null,"DECL_TYPE":null,"CONSIGNEE_NAME":null,"CONSIGNEE_ORG":null,"CONSIGNEE_COUNTRY":null,"CONSIGNEE_CITY":null,"CONSIGNEE_ADDR":null,"CONSIGNEE_POSTCODE":null,"CONSIGNEE_TEL":null,"CONSIGNOR_NAME":null,"CONSIGNOR_ORG":null,"CONSIGNOR_COUNTRY":null,"CONSIGNOR_CITY":null,"CONSIGNOR_ADDR":null,"CONSIGNOR_POSTCODE":null,"CONSIGNOR_TEL":null,"cargoList":[{"GOODS_NAME":"name1","HS_NUMBER":"hsnumber1","HS_CODE":"hscode1"},{"GOODS_NAME":"name2","HS_NUMBER":"hsnumber2","HS_CODE":"hscode2"}],"CARD_ID":"xxx","CARD_FILE":"xxx","picList":[{"PIC_URL":"xxxx","PIC_NAME":"name1","PIC_TYPE":"type1"},{"PIC_URL":"xxxcxccx","PIC_NAME":"name2","PIC_TYPE":"type2"}]},
{"LGS_NO":"333","QTY":null,"WEIGHT":null,"VAL_US":null,"PAY_WAY":null,"ORI_CTRY":null,"MODEL":null,"DECL_TYPE":null,"CONSIGNEE_NAME":null,"CONSIGNEE_ORG":null,"CONSIGNEE_COUNTRY":null,"CONSIGNEE_CITY":null,"CONSIGNEE_ADDR":null,"CONSIGNEE_POSTCODE":null,"CONSIGNEE_TEL":null,"CONSIGNOR_NAME":null,"CONSIGNOR_ORG":null,"CONSIGNOR_COUNTRY":null,"CONSIGNOR_CITY":null,"CONSIGNOR_ADDR":null,"CONSIGNOR_POSTCODE":null,"CONSIGNOR_TEL":null,"cargoList":[{"GOODS_NAME":"name1","HS_NUMBER":"hsnumber1","HS_CODE":"hscode1"},{"GOODS_NAME":"name2","HS_NUMBER":"hsnumber2","HS_CODE":"hscode2"}],"CARD_ID":"xxx","CARD_FILE":"xxx","picList":[{"PIC_URL":"xxxx","PIC_NAME":"name1","PIC_TYPE":"type1"},{"PIC_URL":"xxxcxccx","PIC_NAME":"name2","PIC_TYPE":"type2"}]}
]} - response:
企业
获取企业备案总列表
- url:/exp/rest/org/list
- method:get
- request:
- response:EXP_ORG_INFO列表
获取单个企业备案信息
- url:/exp/rest/org/get
- method:get
- request:id
- response:EXP_ORG_INFO
新增或更新企业信息
- url:/exp/rest/org/save
- method:post
- request:EXP_ORG_INFO对象，id为空新增，其他更新
- response:EXP_ORG_INFO
审核
- url:/exp/rest/org/check
- method:post
- request:id,result(结果，1通过，2不通过),remark
- response:
锁定解锁
- url:/exp/rest/org/lock
- method:post
- request:id,result(0解锁，1锁定)
- response:
申报端申报
- url:/exp/rest/org/Register
- method:post
- request:{"ID":"868189765be5cb47015be5cd0dd20000","ORG_CODE":"33344233255555","ORG_NAME":"宁波口岸测试公司","ORG_TYPE":null,"ADDRESS":"中山路","TEL":"0574-88886666","FACSIMILE_TEL":"0574-88886666","LOCK_FLG":null,"CHECK_FLG":null,"CHECK_TIME":null,"CHECK_REMARK":null,"CONTACT_PERSON":"张三李四","CONTACT_WAY":"12345678901","COUNTRY":"中国","WH_ADDRESS":null,"WH_CONTACT_PERSON":null,"WH_CONTACT_WAY":null,"OU":"OU333f4c6810f89d8a8377341","picList":[{"PIC_URL":"xxxx","PIC_NAME":"name1","PIC_TYPE":"type1"},{"PIC_URL":"xxxcxccx","PIC_NAME":"name2","PIC_TYPE":"type2"}]}
- response:
查验规则
获取列表
- url:/exp/rest/CheckRate/list
- method:get
- request:
- response:EXP_CHECK_RATE列表
获取单个
- url:/exp/rest/CheckRate/get
- method:get
- request:id
- response:EXP_CHECK_RATE
新增或更新
- url:/exp/rest/CheckRate/save
- method:post
- request:EXP_CHECK_RATE对象，id为空新增，其他更新
- response:EXP_CHECK_RATE
审核
- url:/exp/rest/CheckRate/Check
- method:post
- request:{"ID":"xxx"}
- response:
选择
- url:/exp/rest/CheckRate/Select
- method:post
- request:{"ID":"xxx"}
- response:
删除
- url:/exp/rest/CheckRate/Delete
- method:post
- request:{"ID":"xxx"}
- response:
工作日志
获取列表
- url:/exp/rest/WorkLog/list
- method:get
- request:
- response:EXP_WORK_LOG列表
获取单个
- url:/exp/rest/WorkLog/get
- method:get
- request:id
- response:EXP_WORK_LOG
新增或更新
- url:/exp/rest/WorkLog/save
- method:post
- request:EXP_WORK_LOG对象，id为空新增，其他更新
- response:EXP_WORK_LOG
删除
- url:/exp/rest/WorkLog/Delete
- method:post
- request:{"ID":"xxx","CREATE_BY":"username"}
- response:
是否可以新增
- url:/exp/rest/WorkLog/CanAdd
- method:get
- request:userName用户名
- response:{Result = result} result=true可以新增，result=false已添加，不可新增
是否可以编辑
- url:/exp/rest/WorkLog/CanEdit
- method:get
- request:id=当前id，userName=用户名
- response:{Result = result} result=true可以编辑，result=false不可编辑
是否可以删除
- url:/exp/rest/WorkLog/CanDelete
- method:get
- request:id=当前id，userName=用户名
- response:{Result = result} result=true可以编辑，result=false不可编辑
查阅
- url:/exp/rest/WorkLog/Read
- method:post
- request:{"ID":"xxx","LAST_MODIFY_BY":"username"}
- response:
统计
快件业务量统计2
- url:/exp/rest/count/KjCount2
- method:get
- request:startDate=2018-01-01起始时间,endDate=2018-01-08结束时间
- response:Amount=出入境数量,Weight=出入境重量,ImAmount=入境数量,ImWeight=入境重量,ExAmount=出境数量,ExWeight=出境重量
目的地统计
- url:/exp/rest/count/DestinationCount
- method:get
- request:startDate=2018-01-01起始时间,endDate=2018-01-08结束时间,ieFlag=I或者E进出境
- response:CONSIGNEE_CITY=目的地,LGS_COUNT=票数
收发货人统计
- url:/exp/rest/count/ConsigneeCount
- method:get
- request:startDate=2018-01-01起始时间,endDate=2018-01-08结束时间,ieFlag=I或者E进出境
- response:CONSIGNEE_NAME=收件人，CARD_ID=身份证号码，LGS_COUNT=票数，DECL_TYPE=快件类型
不合格快件统计
- url:/exp/rest/count/UnqualifiedCount
- method:get
- request:startDate=2018-01-01起始时间,endDate=2018-01-08结束时间
- response:CheckAmount=进出境查验票数，TyAmount=退运，XhAmount=销毁，ZghgAmount=整改合格放行，UnqualifiedAmount=合计，ImCheckAmount=进境查验票数，ImTyAmount=退运，ImXhAmount=销毁，ImZghgAmount=整改合格放行，ImUnqualifiedAmount=合计，ExCheckAmount=出境查验票数，ExTyAmount=退运，ExXhAmount=销毁，ExZghgAmount=整改合格放行，ExUnqualifiedAmount=合计
