手册

Posted By 123aweqwe | Date: 2019-01-11 17:55:48 | 已有 3 条评论 | 已有 186 人阅读过
 
使用几点说明:
  1. 提交失败时返回内容解析后请根据实际情况,如有必要请给用户弹出提示
  2. 解析提交结果是以errcode值为准
  3. 入住登记时间为提交成功时的时间,如滞留时间过长,请根据自己需要处理,避免带来不必要的麻烦.
  4. 响应数据中包含有服务端时间,如与本地时间相差过大,请及时校对
 
1.注册用户
请求链接:http://127.0.0.1:90/index/hotelapi/register
请求参数:
user=公安登记系统账号
password=公安登记系统密码
isp=可设置为TT 或LT后期测试执行观察响应时间自行选择推荐LT
       请求方式:post或get
响应数据(json):
        失败示例:
{
"time":1547092936,
"msg":"Have Failed",
"errcode":"A017",
"describe":"用户ycxxxx 已经存在.使用用户名和查询密码可查询详情"
}
成功示例:
{
"time":1547093638,
"msg":"success",
"errcode":"A000",
"describe":"注册成功,请牢记查询密码info.password,丢失不可恢复",
"info":{
"user":"用户名",
"password":"查询密码(注意这里是独立的查询密码啡公安登记系统改密码)",
"hotelname":"酒店名称",
"apikey":"apikey"
}
}
 
2查询/修改
请求链接: http://127.0.0.1:90/index/hotelapi/query请求参数:
user=公安登记系统账号
password=查询密码(注册是产生的16位查询密码)
type=query(查询)或modifyk(修改apikey)或modifyp(修改查询密码)   
       请求方式:post或get
响应数据(json):
失败示例:
{
"time":1547094047,
"msg":"Have Failed",
"errcode":"A023",
"describe":"失败"
}
 
成功示例:
{"time":1547094432,
"msg":"success",
"errcode":"A000",
"describe":"修改成功,请牢记",
"info":{
}
说明:info是返回的修改后的用户信息,一旦修改成功原来的apikey或查询密码就会失效 请务必安全保存.不提供查询服务.
 
 
3信息登记
请求参数:
apikey=注册时生成的apikey
user=公安登记系统账号
password=公安登记系统密码
type=1|2|3|4|5|6
isp=可设置为TT 或LT后期测试执行观察响应时间自行选择 推荐LT
apiflg=1 固定值
guest_information=旅客信息json格式 具体看章末示例
type值:
1
2
3
4
5
6
境内入住
境内退房
预留
预留
港澳台入住
港澳台退房
 
  
       请求方式:post
       请求数据guest_information格式:
                            境内入住:
{
"name":"",
"spell":"",
"simspell":"",
"sex":"",
"nation":"",
"borndate":"",
"nativeplace":"",
"paperno":"",
"nativeplacecode":"",
"roomno":"",
"bedno":"",
"papertype":"",
"paperusetime":"",
"workunit":"",
"region":"",
"regioncode":"",
"homeaddress":"",
"lodycause":"",
"lodycausecode":"",
"from":"",
"fromcode":"",
"stayday":"",
"xyklx":"",
"xykhm":"",
"macaddress":"",
"imgbase64":""
}
境内|港澳台退房:
{
"name":"",
"paperno":"",
"sex":"",
"roomno":"",
"lodytime":"",
"goto":"",
"gotocode":""
}
港澳台入住:
{
"name":"",
"spell":"",
"simspell":"",
"paperno":"",
"paperusetimeperiod":"",
"borndate":"",
"sex":"",
"passno":"",
"homeaddress":"",
"from":"",
"fromcode":"",
"roomno":"",
"bedno":"",
"lodycause":"",
"lodycausecode":"",
"stayday":"",
"workunit":"",
"xyklx":"",
"xykhm":"",
"imgbase64":""
}
 
响应数据(json):
失败示例1:
{
"time":1547097890,
"msg":"Have Failed",
"errcode":"A001",
"describe":"guest_information"
}
分析: guest_information参数正确  检查格式 参数名
失败示例2
{
"time":1547098172,
"msg":"Have Failed",
"errcode":"A010",
"describe":"name"
}:
分析:A010错误代码 入住信息不合规范 入住信息guest_information 中的name字段不正确或不符合规范
失败示例3:
{
"time":1547098708,
"msg":"Have Failed",
"errcode":"A015",
"describe":"没有找到对应的入住信息1"
}
 
 
成功示例:
{
"time":1547098097,
"msg":"success",
"errcode":"A000",
"describe":"登记成功"
}
成功示例:
{
"time":1547098884,
"msg":"success",
"errcode":"A000",
"describe":"旅客退房成功"
}
 
境内入住:guest_information参数规范 
name
姓名
*
 
spell
拼音
 
建议填写
simspell
简拼
 
建议填写
sex
性别
*
1或2
nation
名族
*
 
borndate
生日
*
1972-01-05 完整10个长度的日期
nativeplace
籍贯
*
 
paperno
证件号
*
 
nativeplacecode
籍贯编码
*
身份证号前6位
roomno
房间编号
*
 
bedno
床位号
 
 
papertype
证件类型
*
In:
身份证
 军官证
 户口簿
 警官证
 士兵证
 其他证件
paperusetime
有效期
*
In:
五年
十年
二十年
长期
临时
其他
workunit
工作单位
 
 
region
地址行政区划
*
 
regioncode
地址行政区划代码
 
可通过接口查询
homeaddress
地址
*
详细完整地址
lodycause
入住原因
 
In:
01    务工
02    务农
03    经商
04    服务
05    因公出差
06    借读培训
07    治病疗养
08    当保姆
09    投靠亲友
10    探亲访友
11    旅游观光
12    其他
lodycausecode
入住原因代码
 
参考入住原因
from
来自哪里
 
 
fromcode
来自哪里行政区划代码
 
可通过接口查询
stayday
停留时间天数
 
 
xyklx
信用卡类型
 
 
xykhm
行用卡号码
 
 
macAddress
主机mac
 
 
imgBase64
照片
*
Jpg格式头像base64编码 原则上必须填项
 
 
 
 
 
 
 
退房guest_information规范
 
name
姓名
 
建议不填,留空
paperno
证件号
*
必填
sex
性别
 
建议不填 留空
roomno
房间号
*
必填
lodytime
入住日期
*
注意:填写入住日期例如2015-01-05完整10个长度的日期 ,时间指入住登记提交成功的时间即为入住时间
goto
去哪里
 
 
gotocode
去哪里行政编码
 
可通过接口查询
 
 
 
 
港澳台入住guest_information参数规范:     
name
姓名
*
 
spell
拼音
 
建议填写
simspell
简拼
 
建议填写
paperno
证号
*
 
paperusetimeperiod
有效期
 
格式:2018.10.01-2020.10.01
borndate
生日
*
1972-01-05 完整10个长度的日期
sex
性别
*
1或2
passno
通行证号
*
 
homeaddress
居住地址
*
 
from
来自哪里
 
 
fromcode
来自哪里行政区划
 
可通过接口查询
roomno
房间号
*
 
bedno
床位号
 
 
lodycause
入住原因
 
In:
01    务工
02    务农
03    经商
04    服务
05    因公出差
06    借读培训
07    治病疗养
08    当保姆
09    投靠亲友
10    探亲访友
11    旅游观光
12    其他
lodycausecode
入住原因代码
 
参考入住原因
stayday
停留天数
 
 
workunit
工作单位
 
 
xyklx
信用卡类型
 
 
xykhm
信用卡号码
 
 
imgBase64
照片
 
Jpg格式头像base64编码 原则上必须填项
 
 
 
行政区划编码查询接口:
请求链接: http://127.0.0.1:90/index/hotelapi/area请求参数:
user=公安登记系统账号
apikey=注册时产生的apikey
field= code(根据编码查区划)|region(更具区划查编码) 
word=关键字(更具field来决定word内容)
      请求方式:post或get
响应数据(json):  
错误示例:
{
"errcode":"A024",
"time":1547196072,
"msg":"Have Failed",
"describe":"检查用户信息"
}
                            正确示例:
{
"time":1547197593,
"msg":"success",
"errcode":"A000",
"info":[
{
"region":"浙江省杭州市",
"code":"330100"
},
{
"region":"浙江省杭州市市辖区",
"code":"330101"
},
{
"region":"浙江省杭州市上城区",
"code":"330102"
},
{
"region":"浙江省杭州市下城区",
"code":"330103"
},
{
"region":"浙江省杭州市江干区",
"code":"330104"
},
{
"region":"浙江省杭州市拱墅区",
"code":"330105"
},
{
"region":"浙江省杭州市西湖区",
"code":"330106"
},
{
"region":"浙江省杭州市半山区",
"code":"330107"
},
{
"region":"浙江省杭州市滨江区",
"code":"330108"
},
{
"region":"浙江省杭州市萧山区",
"code":"330109"
},
{
"region":"浙江省杭州市余杭区",
"code":"330110"
},
{
"region":"浙江省杭州市区",
"code":"330120"
}
],
"describe":"查询成功"
}
 
PS:注意选择关键字 关键字不巧当 可能导致结果数据过多或匹配不到结果
 
 
返回错误代码说明
A开头普通错误
B开头未知系统错误,联系管理员
A000  成功
A011 成功!但图象保存失败!
A012 登记失败
A013 登记失败 若重复出现此错误代码请联系管理员
A001 用户提交时初步检查 参数缺少 或格式不正确  
A002 检查用户信息 I
A003 暂无权限
A004 有效期到   
A005 账号或密码 错误
A006 民警注销或停业  
A007 停业状态或民警注销
A008 错误,请联系管理员
A009 超时
A010 入住信息不合规范
A014 退房信息不合规范
A015 退房时为找到入住信息
A016 退房失败
A017 注册失败 已经注册过  
A018 A019 注册失败  
A020 注册失败 用户名或密码格式不对  
A021 修改或查询信息失败 基本数据格式不对 已经注册过  
A022 修改或查询失败  
A023 修改或查询失败 可能是账号或密码错误  
 
 
B001 用户提交时初步检查出错
B002 检查用户权限  出错
B003 修改查询用户出错
B004 注册用户出错
 
 
 
 
 
 
 
 
 
 
 
 
 
 

 

如果觉得此内容对您的学习有所帮助,您可以支付宝捐赠一下。

支付宝账号 : weizeyan52@126.com

评论

文明社会,从理性发言开始。谢绝地域攻击。