open.shopweb.device.getDeviceList （Obtaining the Device List）Sandbox debugging
Obtaining the Device List
Interface description#
| The environment | Interface method | Submission method | Do you need a signature | HTTP request routing |
|---|---|---|---|---|
| Formal environment | open.shopweb.device.getDeviceList | POST | true | http://openapi.opretail.com/m.api |
Common request parameters#
| Parameters | Types of | Is required | The maximum length | Description | Example values |
|---|---|---|---|---|---|
| _aid | String | True | 20 | Open platform system number, fixed to S107 | S107 |
| _akey | String | True | 20 | Opretail open platform assigns developer keys to third parties | Obtained after certification of platform developer |
| _mt | String | True | 100 | Interface name | open.shopweb.device.getDeviceList |
| _sm | String | True | 100 | Signature algorithm md5,sha1 | md5 |
| _requestMode | String | True | 100 | Request method post,get | POST |
| _version | String | True | 100 | Version number | v1 |
| _timestamp | String | True | 100 | Timestamp | yyyyMMddHHmmss format |
| _sig | String | True | 32 | Signature token | Generated according to the signature algorithm, see the signature algorithm rules for details |
| _format | String | False | 10 | Format type | Currently only supports json by default |
Business request parameters#
| Parameters | Types of | Is required | The maximum length | Description | Example values |
|---|---|---|---|---|---|
| id | int | √ | Store ID |
Common response parameters#
| Parameters | Types of | The maximum length | Description | Example values |
|---|---|---|---|---|
| stat | JSON | - | Gateway status (specific parameters are described below :) | View |
| stat.cid | String | 100 | Http request identifier | |
| 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 | Interface returns prompt information | |
| data | JSON | - | Business information returned by the interface call (generally json format data, the specific data format will be defined in the business return parameters) | View |
Business return parameters#
| Parameter | Types of | Whether to return | Returns the maximum length | Description | Example values |
|---|---|---|---|---|---|
records | JSON | × | Results | View | |
| int | × | 【records】Device ID | |||
| string | × | 【records】Device Mac | |||
| string | × | 【records】Device Type | |||
| string | × | 【records】Device Name | |||
| string | × | 【records】Device Version | |||
| int | × | 【records】Platform ID | |||
| string | × | 【records】Platform Address | |||
| long | × | 【records】Creation Time | |||
| string | × | 【records】Device IP | |||
| int | × | 【records】Enterprise ID | |||
| long | × | 【records】Size | |||
| int | × | 【records】Device Online Status(1:online） | |||
| JSON | × | 【records】List of Sub-device under the NVR | View | ||
| boolean | × | 【deviceStatusLst】Device DMS Online Status(false: Offline) | |||
| int | × | 【deviceStatusLst】Video Device ID | |||
| int | × | 【deviceStatusLst】Device Regist Method(0: Directly Regist;1:VSIP Cameras; 2: ONVIF; 3: RTSP) | |||
| int | × | 【deviceStatusLst】Type of video stream get from (0: get through websocket; 1: get through streaming platform) | |||
| string | × | 【deviceStatusLst】Video Device Mac | 61ac7b42c75a | ||
| string | × | 【deviceStatusLst】Video Device ip | 172.16.3.18 | ||
| int | × | 【deviceStatusLst】Video Device Online Status(0: Offline; 1: Online) | 1 |
Public return code#
| Return code name | Return code | Return code description | Solution |
|---|---|---|---|
| SUCCESS | 0 | Call success | |
| KEY_NOTNULL | 1 | _akey can not be empty | Input the _akey parameter when the interface is called |
| KEY_UNLAWFUL | 2 | _akey is illegal | key is illegal, input in the correct key |
| KEY_HAS_EXPIRED | 3 | _akey has expired | Please renew the service or contact the platform administrator |
| SIGN_METHOD_NOTNULL | 4 | _sm parameter cannot be empty | Input the _sm parameter when the interface is called |
| SIGN_TYPE_NOTEXIST | 5 | _sm type does not exist | Currently only supports md5, sha1 |
| SIGN_NOTNULL | 6 | _sig parameter cannot be empty | Input the _sig parameter when the interface is called |
| SIGN_WRONG | 7 | Invalid signature, please check parameters and signature format | _sig value is generated according to the signature algorithm |
| METHOD_NOTNULL | 8 | _mt parameter cannot be empty | Input the _mt parameter when the interface is called |
| METHOD_NOTEXIST_CODE | 9 | The method name corresponding to _mt does not exist or is not registered in the service | Check if the method corresponding to _mt method name and _version version number is passed in error |
| REQUESTMODE_NOTNULL | 10 | _requestMode parameter cannot be empty | Input the _requestMode parameter when the interface is called |
| APPLICATIONID_NOTNULL | 11 | _aid parameter cannot be empty | Input the _aid parameter when the interface is called |
| 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 | Input the _version parameter when the interface is called |
| TIMESTAMP_NOTNULL | 14 | _timestamp timestamp cannot be empty | Input the _timestamp parameter when the interface is called |
| TIMESTAMP_FORMAT_ERROR | 15 | _timestamp timestamp formatting error | According to yyyyMMddHHmmss format |
| TIMESTAMP_OVERTIME | 16 | _timestamp has expired | _timestamp is regenerated every time the interface is called |
| FORMAT_TYPE_NOTEXIST | 17 | _format type does not exist | Currently only supports json (default), xml |
| API_CALL_REPEAT | -100 | The interface is called repeatedly | Interface platform call exception |
| API_SYSTEM_CALL_ERROR | -500 | API call failed, system exception occurred | Interface platform call exception |
| UNKNOWN_ERROR | -999 | Open platform system exception | Reissue request |
Business return code#
| Return code name | Return code | Return code description |
|---|