万店掌 开放平台 获取对应角色列表对应的人员列表(请求头中必须有token参数,参数名为authenticator,该值从用户API中的登陆接口获得)
联系我们

open.shopweb.role.getRoleAndUsersAsConfig (获取对应角色列表对应的人员列表(请求头中必须有token参数,参数名为authenticator,该值从用户API中的登陆接口获得))沙箱调试

获取对应角色列表对应的人员列表(请求头中必须有token参数,参数名为authenticator,该值从用户API中的登陆接口获得)

接口描述#

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

公共请求参数#

参数类型是否必填最大长度描述示例值
_aidString20开放平台系统编号,固定为S107S107
_akeyString20万店掌开放平台分配给第三方的开发者key认证平台开发者后获取
_mtString100接口名称open.shopweb.role.getRoleAndUsersAsConfig
_smString100签名算法 md5,sha1md5
_requestModeString100请求方式post,getPOST
_versionString100版本号v1
_timestampString100时间戳yyyyMMddHHmmss格式
_sigString32签名token根据签名算法生成,详情见签名算法规则
_formatString10format类型目前默认仅支持json

业务请求参数#

参数类型是否必填最大长度描述示例值
deptId
int门店id

公共响应参数#

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

业务返回参数#

参数名称类型是否一定返回返回最大长度描述示例值
role
JSON×角色查看
    
id
string×【role】角色id
    
roleName
string×【role】角色名称
    
privileges
string×【role】角色权限
    
groupId
int×【role】企业id
    
userCount
int×【role】用户数量
    
groupName
string×【role】企业名称
    
pid
int×【role】所属父类id
    
isGrades
int×【role】是否是职级字段,0否 1是 (默认为0)
    
childRoles
string×【role】子角色
    
belongGrade
JSON×【role】所属职级查看
    
applyToDpet
int×【role】应用到门店 0:不应用 1应用
    
rolePrivileges
JSON×【role】角色权限表查看
        
id
int×【rolePrivileges】主键id
        
roleId
int×【rolePrivileges】角色id
        
privilegeId
int×【rolePrivileges】权限id
    
userDo
JSON×用户查看
        
id
int×【userDo】用户id
        
userName
string×【userDo】登录名
        
showName
string×【userDo】用户名
        
phone
string×【userDo】手机号

公共返回码#

返回码名称返回码返回码描述解决方案
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开放平台系统异常重新发起请求

业务返回码#

返回码名称返回码返回码描述
BUSINESS_PLATFORM_UNBOUND
103001业务平台未做绑定,请联系客服
DATA_NOT_NULL
103002必填字段不能为空
PARAMETER_VALIDATE_ERROR
103004参数效验异常
IDENTITY_INFORMATION_WRONG
103005身份信息有误,_akey与企业id不匹配
SERVICE_TIMEOUT
103066服务请求超时
API_SYSTEM_ERROR
103999api服务未知异常
PASSWORD_ERROE
103095密码错误
USERNAME_ERROE
103094用户名错误