Updated:2016-9-28Oneconn Public Platform Overview

All this interfaces are 1.0 alpha varsion.

Begin To Develop

Before you invoke interfaces on oneconn platform , you need to:
      1. Login oneconn platform,and authenticate your industry.
      You can commit your request to authenticate industry on User Center(setting-index), and once you commit it , our staff will authenticate your request. The result of authentication will display on User Center(setting-index).
      2. Apply your key on oneconn after passing the authentication You can click “Apply” button to apply a key on Key Management(key-index), and your new key will display as a list on the page. Every user can apply more than one key, so that you can use your key in different purpose.
      3. Register a device, or add one existed on oneconn You can register a device that you use to invoke interfaces on Device Register (device-register) page, or add one on Device Management(device-index). Of course, every user can have more than one device.

User Information


Get all devices by industry: getDeviceNumberByCompany

Interface getDeviceNumberByCompany
Request Method POST
Request Parameter
Parameter Type Require Detail
key String Y The key you applied on oneconn,is used to identify user.
field String Y Industry Name
page int N Page to load,default 1.
rows int N Count of per loading,default 50
 
Return Json
Parameter Type Detail
success int 0->fail,1->succeed
error int Error Code
extra String Extra Information
count int Count of loaded data
field String Industry Name
data Array Array of response data
Example Request:
{key:123456789,
field:cimc[,
page:1,
rows:20]
}
Response:
1.Loading fail:
{
"success": 0,
"error":2,
"extra": "Wrong format of request data",
"field": "cimc",
}
2.Loading succeed:
{
"success": 1,
"field": "cimc",
"count":22,
"data": [
{
id: 2,
devname:device-type-1,
devid:012345678910,
simid:10987654321,
devPattern:pattern-0001,
middlename:middle-001,
devIndustry:industry-001
},
......
]
}

Get all device by device model: getDeviceByModel

Interface getDeviceByModel
Request Method POST
Request Parameter
Parameter Type Require Detail
key String Y The key you applied on oneconn,is used to identify user.
field String Y Device Model
page int N Page to load,default 1.
rows int N Count of per loading,default 50
 
Return Json
Parameter Type Detail
success int 0->fail,1->succeed
error int Error Code
extra String Extra Information
count int Count of loaded data
field String Device Models
data Array Array of response data
Example Request:
{key:123456789,
field:model-123[,
page:1,
rows:10]
}
Response:
1. Loading fail:
{
"success": 0,
"error":2,
"extra": "Wrong format of request data",
"field": "cimc",
}
2.Loading succeed
{
"success": 1,
"field": "cimc",
"count":22,
"data": [
{
id: 2,
devname:device-type-1,
devid:012345678910,
simid:10987654321,
devPattern:pattern-0001,
middlename:middle-001,
devIndustry:industry-001
},
......
]
}

Get all devices which belong to user by industry: getUserIndustryDevice

Interface getUserIndustryDevice
Request Method POST
Request Parameter
Parameter Type Require Detail
key String Y The key you applied on oneconn,is used to identify user.
field String Y Industry Name
page int N Page to load,default 1.
rows int N Count of per loading,default 50
 
Return Json
Parameter Type Detail
success int 0->fail,1->succeed
error int Error Code
extra String Extra Information
count int Count of loaded data
field String Industry Name
data Array Array of response data
Example Request:
{key:123456789,
field:model-123[,
page:1,
rows:10]
}
Response:
1.Loading fail:
{
"success": 0,
"error":2,
“extra”: “Wrong format of request data”,
"field": "cimc",
}
2.Loading succeed
{
"success": 1,
"field": "cimc",
"count":22,
"data": [
{
id: 2,
devname:device-type-1,
devid:012345678910,
simid:10987654321,
devPattern:pattern-0001,
middlename:middle-001,
devIndustry:industry-001
},
......
]
}

Get all specified user's devices: getUserDevice

Interface getUserDevice
Request Method POST
Request Parameter
Parameter Type Require Detail
key String Y The key you applied on oneconn,is used to identify user.
page int N Page to load,default 1.
rows int N Count of per loading,default 50
 
Return Json
Parameter Type Detail
success int 0->fail,1->succeed
error int Error Code
extra String Extra Information
count int Count of loaded data
data Array Array of response data
Example Request:
{key:123456789[,
page:1,
rows:10]
}
Response:
2. Loading fail:
{
"success": 0,
"error":2,
“extra”: “Wrong format of request data”,
"field": "cimc",
}
2.Loading succeed
{
"success": 1,
"count":22,
"data": [
{
id: 2,
devname:device-type-1,
devid:012345678910,
simid:10987654321,
devPattern:pattern-0001,
middlename:middle-001,
devIndustry:industry-001
},
......
]
}

Get specified user's device by device type: getDeviceByType

Interface getDeviceByType
Request Method POST
Request Parameter
Parameter Type Require Detail
key String Y The key you applied on oneconn,is used to identify user.
field String Y Device Type
page int N Page to load,default 1.
rows int N Count of per loading,default 50
 
Return Json
Parameter Type Detail
success int 0->fail,1->succeed
error int Error Code
extra String Extra Information
count int Count of loaded data
field String Device Type
data Array Array of response data
Example Request:
{key:123456789,
field:type-123[,
page:1,
rows:10]
}
Response:
3. Loading fail:
{
"success": 0,
"error":2,
"extra": "Wrong format of request data",
"field": "cimc",
}
2.Loading succeed
{
"success": 1,
"field": "cimc",
"count":22,
"data": [
{
id: 2,
devname:device-type-1,
devid:012345678910,
simid:10987654321,
devPattern:pattern-0001,
middlename:middle-001,
devIndustry:industry-001
},
......
]
}