万店掌 开放平台 通过开放平台新增/修改人员
{ "idx": null }

open.shopweb.user.saveUserByOpenPlatform （通过开放平台新增/修改人员）

通过开放平台新增/修改人员

接口描述#

环境接口方法提交方式是否需要签名HTTP请求路由
正式环境open.shopweb.user.saveUserByOpenPlatformPOSTtruehttp://cloudapi.ovopark.com/cloud.api

公共请求参数#

参数类型是否必填最大长度描述示例值
_aidString是20开放平台系统编号，固定为S107S107
_akeyString是20万店掌开放平台分配给第三方的开发者key认证平台开发者后获取
_mtString是100接口名称open.shopweb.user.saveUserByOpenPlatform
_smString是100签名算法 md5,sha1md5
_requestModeString是100请求方式post,getPOST
_versionString是100版本号v1
_timestampString是100时间戳yyyyMMddHHmmss格式
_sigString是32签名token根据签名算法生成，详情见签名算法规则
_formatString否10format类型目前默认仅支持json

业务请求参数#

参数类型是否必填最大长度描述示例值
json		JSON√99json请求类型查看
    
id		int×0ID不传为新增
    
userName		string√0用户帐号
    
showName		string√0显示名称
    
phone		string×0电话
    
mobilePhone		string×0移动电话
    
mail		string×0邮箱
    
localelan		string×0区域语言
    
pId		int×0上级用户的id
    
validateDate		date×0创建时间
    
thumbUrl		string×0用户头像
    
groupId		int√0用户所属企业分组
    
isSingleSign		int×0新增字段手机APP中是否是单点登录
    
employeeNumber		string×0工号
    
pyName		string×0拼音名
    
pyFirst		string×0拼音首字母
    
isFrozen		int×00正常 1被冻结
    
staffImageUrl		string×0员工头像
    
position		string×0职位，岗位
    
validateStatus		int×0有效状态 0 正常 1 已过期 2 即将过期
    
franchiseeType		int×0 加盟商类型 0 普通账号 1 加盟商 2 加盟商员工
    
franchiseeTime		date×0加盟日期
    
contractStartTime		date×0合同开始时间
    
contractEndTime		date×0合同结束时间
    
contractUrl		JSON×0合同URL【集合】查看
    
roleIds		JSON×0角色id【集合】查看
    
configureContents		JSON×0自定义字段【集合】查看
    
roleDepStr		JSON×0角色对应 门店【集合】查看
    
needSms		int×0登录是否需要短信验证码验证
    
isDelFranchiseeContract		int×0是否 删除加盟商合同 0 未删除 1 已删除
    
depIds		JSON×0门店id【集合】查看
    
shopIds		JSON×0门店权限 店铺id【集合】查看
    
orgPermissionIds		JSON×0门店权限 组织架构id【集合】查看
    
orgPermissionIdThirdOrgId		JSON×0 门店权限 部门编码【集合】查看
    
userOrganizeIds		JSON×0通讯录 组织架构id查看
    
userOrganizeDepIds		JSON×0通讯录 传 门店id【集合】查看
    
userOrganizeShopIds		JSON×0 通讯录 传 门店shopId【集合】查看
    
userOrganizeThirdOrgIds		JSON×0通讯录 传 部门编码【集合】查看
    
userDepList		JSON×0作为店长的门店id 集合查看
    
userShopIdList		JSON×0作为店长的店铺id 集合查看
    
password		string√0密码（修改人员信息是不需要传）

公共响应参数#

参数类型最大长度描述示例值
statJSON-网关状态(具体参数描述如下：)查看
stat.cidString100http请求的标识符
stat.codeString100网关返回码
stat.codenameString100网关返回码名称
stat.systimeStringLong接口调用的当前时间
resultString100接口返回提示信息
dataJSON-接口调用返回的业务信息(一般是json格式数据，具体数据格式会在业务返回参数中定义)查看

业务返回参数#

参数名称类型是否一定返回返回最大长度描述示例值
data		JSON×11返回data查看

公共返回码#

返回码名称返回码返回码描述解决方案
SUCCESS0调用成功
KEY_NOTNULL1_akey和不能为空接口调用时传入_akey参数
KEY_UNLAWFUL2_akey不合法key是非法的,传入正确的key
KEY_HAS_EXPIRED3_akey已过期请续订服务或联系平台管理人员
SIGN_METHOD_NOTNULL4_sm参数不能为空接口调用时传入_sm参数
SIGN_TYPE_NOTEXIST5_sm类型不存在目前仅支持md5,sha1
SIGN_NOTNULL6_sig参数不能为空接口调用时传入_sig参数
SIGN_WRONG7无效的签名，请检查参数和签名格式_sig值根据签名算法生成
METHOD_NOTNULL8_mt参数不能为空接口调用时传入_mt参数
METHOD_NOTEXIST_CODE9_mt对应的方法名不存在或未注册进服务检查_mt方法名和_version版本号对应的方法是否传入错误
REQUESTMODE_NOTNULL10_requestMode参数不能为空接口调用时传入_requestMode参数
APPLICATIONID_NOTNULL11_aid参数不能为空接口调用时传入_aid参数
APPLICATIONID_NOTSAME12_aid与当前key不匹配_aid与_akey必须一一对应
VERSION_NOTNULL13_version版本号不能为空接口调用时传入_version参数
TIMESTAMP_NOTNULL14_timestamp时间戳不能为空接口调用时传入_timestamp参数
TIMESTAMP_FORMAT_ERROR15_timestamp时间戳格式化错误按照yyyyMMddHHmmss格式
TIMESTAMP_OVERTIME16_timestamp已失效_timestamp每次接口调用时重新生成
FORMAT_TYPE_NOTEXIST17_format类型不存在目前仅支持json(默认),xml
API_CALL_REPEAT-100接口重复调用接口平台调用异常
API_SYSTEM_CALL_ERROR-500api调用失败，系统发生异常接口平台调用异常
UNKNOWN_ERROR-999开放平台系统异常重新发起请求

业务返回码#

返回码名称返回码返回码描述
code		0seccess