智能一卡通管理系统6700平台sdkv2.0.0(平台部分)概要.docx

平台SDK开发手册 平台SDK开发手册非常感谢选择本公司产品，我们将竭诚为您提供最好的服务本手册内容将不定期更新，恕不另行通知；更新内容将在版本更新信息中给出如您对手册中的内容有疑惑或者有好的建议，请通过技术支持联系我们我们的进步需要您的宝贵意见1. 简介1.1 前提第三方对外WebService接口是基于智能一卡通6700 (V2.0.0)版本，在使用接口前，请确认您已经安装好了该版本软件，并且已经成功运行1.2 WebService接口地址接口地址采用统一的地址形式（如：http://127.0.0.1/services/ThirdSdkService），具体以版本发布说明为准1.3 版本信息版本号日期修订者修改内容1.0.02015-03-23高嵩创建2. 接口定义2.1 用户接口定义2.1.1 登录接口接口名称：String userLogin (String xml)接口描述：第三方用户登录接口1) 参数参数名参数描述类型必要字段备注userName用户名StringYuserPwd用户密码StringY已加密ip用户IPStringYport用户端口IntegerY2) 参数报文 3) 返回值参数名参数描述类型备注Xml参数errorCode错误码Integer错误码，为“0”代表成功，其他错误码请对照错误码描述表查找。

result结果是否正确Boolean返回结果，true代表成功,false代表失败sessionId用户登录会话String用户成功登录后，返回的用户登录标记4) 返回报文 2.1.2 登出接口接口名称：String userLogOut (String xml)接口描述：用户登出接口1) 参数参数名参数描述类型必要字段备注sessionId用户登录会话StringY用户成功登录后，返回的用户登录标记2) 参数报文 3) 返回值参数名参数描述类型备注Xml参数errorCode错误码Integer错误码，为“0”代表成功，其他错误码请对照错误码描述表查找result结果是否正确Boolean返回结果，true代表成功,false代表失败。

4) 返回报文 2.1.3 添加用户接口（仅支持单点登录对接版本，普通版本不支持）接口名称：String  addUser (String xml)接口描述：添加用户接口1) 参数参数名参数描述类型必要字段备注sessionId用户登录会话StringY用户成功登录后，返回的用户登录标记operId操作者IDStringY loginAccount登录名称StringYadmin用户不能添加userName用户名称StringYendTime有效结束时间LongYuserDesc用户描述StringN2) 参数报文 ……    3) 返回值参数名参数描述类型备注Xml参数errorCode错误码Integer错误码，为“0”代表成功，其他错误码请对照错误码描述表查找。

result结果是否正确Boolean返回结果，true代表成功,false代表失败loginAccount登录账户String4) 返回报文 ……. 2.1.4 修改用户接口（仅支持单点登录对接版本，普通版本不支持）接口名称：String updateUser (String xml) 接口描述：修改用户接口1) 参数参数名参数描述类型必要字段备注sessionId用户登录会话StringY用户成功登录后，返回的用户登录标记operId操作者IDStringY loginAccount登录名称StringYadmin用户不能添加userName用户名称StringYendTime有效结束时间LongYuserDesc用户描述StringN2) 参数报文 …… 3) 返回值参数名参数描述类型备注Xml参数errorCode错误码Integer错误码，为“0”代表成功，其他错误码请对照错误码描述表查找。

result结果是否正确Boolean返回结果，true代表成功,false代表失败loginAccount登录账户String4) 返回报文 ……. 2.1.5 删除用户接口（仅支持单点登录对接版本，普通版本不支持）接口名称：String deleteUser(String xml)接口描述： 删除用户接口1) 参数参数名参数描述类型必要字段备注sessionId用户登录会话StringY用户成功登录后，返回的用户登录标记operId操作者IDStringY userNames需要删除的用户名称IntegerY用逗号隔开 2) 参数报文< operId > 3) 返回值参数名参数描述类型备注Xml参数errorCode错误码Integer错误码，为“0”代表成功，其他错误码请对照错误码描述表查找。

result结果是否正确Boolean返回结果，true代表成功,false代表失败loginAccount登录账户String4) 返回报文 ……. 2.2 组织资源接口定义2.2.1 获取控制中心信息接口接口名称：String getControlUnitInfo (String xml)接口描述：获取控制中心列表信息1) 参数参数名参数描述类型必要字段备注sessionId用户登录会话StringY用户成功登录后，返回的用户登录标记controlUnitId控制中心IdIntegerY当contentChr为0时，可在xml请求报文中去掉此节点contentChr查询方式IntegerY0全部中心，1包括子中心，2不包括子中心2) 参数报文 3) 返回值参数名参数描述类型备注Xml参数errorCode错误码Integer错误码，为“0”代表成功，其他错误码请对照错误码描述表查找。

result结果是否正确Boolean返回结果，true代表成功,false代表失败控制中心字段的定义controlUnitId中心IDIntege。