Register

open.shopweb.user.getUsersByEnterprise （获取企业所有用户）

获取该企业下所有用户

Interface Description #

Environment Interface Method Submission Method Requires Signature The identifier of the http request
Formal environment open.shopweb.user.getUsersByEnterprise POST true https://openapi.opretail.com/cloud.api

Public Request Parameters #

Parameter Type Required Max Length Description Example Value
_aid String Yes 20 Open platform system ID, fixed as S107 S107
_akey String Yes 20 Developer key assigned by Wanzdianzhang Open Platform to third parties Obtained after authenticating platform developer
_mt String Yes 100 Interface name open.shopweb.user.getUsersByEnterprise
_sm String Yes 100 Signature algorithm md5, sha1 md5
_requestMode String Yes 100 Request method post, get POST
_version String Yes 100 Version number v1
_timestamp String Yes 100 Timestamp yyyyMMddHHmmss format
_sig String Yes 32 Signature token Generated according to signature algorithm, see signature algorithm rules for details
_format String No 10 Format type Currently only json is supported by default

Business Request Parameters #

Parameter Type Required Max Length Description Example Value
pageNumber int √ 11 Current page 1
pageSize int √ 11 Number per page 10
enterpriseId int √ 11 enterprise id 123

Public Response Parameters #

Parameter Type Max Length Description Example Value
stat JSON - Gateway status (specific parameters are described as follows: View
stat.cid String 100 The identifier of the http request
stat.code String 100 Gateway return code
stat.codename String 100 Gateway return code name
stat.systime String Long The current time of the interface call
result String 100 The interface returns prompt information
data JSON - Business information returned by the interface call (usually in JSON format, the specific data format will be defined in the business return parameters) View

Business Response Parameters #

apiDetail.parameterName Type Required Max Length Description Example Value
total int × 11 Total 10
size int × 11 Number per page 10
current int × 11 Current page 1
pages int × 11 page number 1
records JSON × 11 Return data View
userId int × [records] user id
userName string × [records] login name
showName string × [records] username
deptOrgIds string × [records] Organization structure permissions 123,456
chatOrganizeIds string × [records] address book organization structure permissions 123,456
roleIds string × [records] role id
×
privilegeIds string × [records] menu permission id 123,456

Public Return Codes #

Return code name Return code Return Code Description Solution
SUCCESS 0 Call success
KEY_NOTNULL 1 _akey cannot be empty Pass in the _akey parameter when calling the interface
KEY_UNLAWFUL 2 _akey is illegal The key is illegal, enter the correct key
KEY_HAS_EXPIRED 3 _akey has expired Please renew your service or contact the platform administrator
SIGN_METHOD_NOTNULL 4 The _sm parameter cannot be empty Pass in the _sm parameter when calling the interface
SIGN_TYPE_NOTEXIST 5 _sm type does not exist Currently only supports md5, sha1
SIGN_NOTNULL 6 The _sig parameter cannot be empty Pass in the _sig parameter when calling the interface
SIGN_WRONG 7 Invalid signature, please check the parameters and signature format The _sig value is generated according to the signature algorithm
METHOD_NOTNULL 8 apiDetail.mtParameterCannotBeEmpty apiDetail.passInTheMtParameterWhenCallingTheInterface
METHOD_NOTEXIST_CODE 9 The method name corresponding to _mt does not exist or is not registered in the service Check whether the method corresponding to the _mt method name and _version version number has an error in passing
REQUESTMODE_NOTNULL 10 The _requestMode parameter cannot be empty Pass in the _requestMode parameter when calling the interface
APPLICATIONID_NOTNULL 11 _aid parameter cannot be empty Pass in the _aid parameter when calling the interface
APPLICATIONID_NOTSAME 12 _aid does not match the current key _aid and _akey must correspond one to one
VERSION_NOTNULL 13 _version version number cannot be empty Version number
TIMESTAMP_NOTNULL 14 _timestamp timestamp cannot be empty Pass in the _timestamp parameter when calling the interface
TIMESTAMP_FORMAT_ERROR 15 _timestamp timestamp format error Follow the yyyyMMddHHmmss format
TIMESTAMP_OVERTIME 16 _timestamp has expired _timestamp is regenerated each time the interface is called
FORMAT_TYPE_NOTEXIST 17 _format type does not exist Currently only supports json (default), xml
API_CALL_REPEAT -100 Interface duplicate call Interface platform call exception
API_SYSTEM_CALL_ERROR -500 API call failed, system exception Interface platform call exception
UNKNOWN_ERROR -999 Open platform system exception Reinitiate request

Business Return Codes #

Return code name Return code Return Code Description
BUSINESS_PLATFORM_UNBOUND 103001 业务平台未做绑定,请联系客服
DATA_NOT_NULL 103002 必填字段不能为空
PARAMETER_VALIDATE_ERROR 103004 参数效验异常
IDENTITY_INFORMATION_WRONG 103005 身份信息有误,_akey与企业id不匹配
SERVICE_TIMEOUT 103066 服务请求超时
API_SYSTEM_ERROR 103999 api服务未知异常