接收客房授权凭据

办理入住退房时调用,接收客房授权凭据

公共参数

请求地址:
环境 方法 HTTP请求地址
正式环境 POST http://ota.yystart.com/api/v1/pms/roomchange
头部信息:
名称 类型 是否必须 描述
Content-TypeString固定为application/json

请求参数

名称 类型 是否必须 示例值 描述
ActionStringcheckincheckin:办理入住,checkout:办理退房
WxAppIdStringwx8a81cadf68c6b6a0微信公众号唯一编号
WxOpenIdStringowzVhwrOIl43l_XZdGW23xtXs4ac微信用户识别编号
RoomNameStringA1001房间编号,与平台中绑定设备的房间编号对应
BeginTimeDate1999/1/1 00:00:00入住开始时间,办理入住时需要
EndTimeDate2017/5/19 12:00:00入住结束时间,办理入住时需要

响应参数

名称 类型 示例值 描述
codeInteger0返回码,0表示成功,其余为失败
msgStringsuccess返回信息,成功时信息固定为success,失败为具体的错误信息

请求示例

  • JSON请求示例
{
  "Action": "checkin",
  "WxAppId": "wx8a81cadf68c6b6a0",
  "WxOpenId": "owzVhwrOIl43l_XZdGW23xtXs4ac",
  "RoomName": "A1001",
  "BeginTime": 1495682044276,
  "EndTime": 1495682044276
}

响应示例

  • JSON成功示例
{
  "code": 0,
  "msg": "success"
}

状态码解释

状态码 描述
200 请求成功
400 参数错误(请检查参数名和值是否正确)
401 管理凭证不合法(请检查authId,authToken正确性)
415 MediaType错误(请在header中添加Content-Type:application/json)
500 服务器内部错误(服务器错误,请联系管理员)