DeviceCore
Use the DeviceCore web service to create, register, modify, or delete OEM Cloud devices or to retrieve information about a registered device. You can retrieve settings, connection information, and state information for a registered device.
URI
http://<hostname>/ws/DeviceCore
Formats
| HTTP method | Format | Description |
|---|---|---|
| GET | /ws/DeviceCore |
Get a list of devices provisioned in your account. |
| POST | /ws/DeviceCore/{devConnectwareId} | Add or register a device in your account. |
| PUT | /ws/DeviceCore/[{id}|{devConnectwareId}] | Add descriptive text fields for the device. |
| DELETE | /ws/DeviceCore/[{id} | Delete a device from your account. |
Elements
cstId
OEM Cloud identifier for the customer.
devCellularModemId
Modem identifier of the device.
devConnectwareId
Device identifier of the device.
devEffectiveStartDate
Date the device was provisioned in OEM Cloud.
devInstallCode
Installation code for the device. An installation code is required for any device manufactured with an associated installation code.
- If you attempt to add a device that requires an installation code with a missing or incorrect code, you receive an HTTP status 400 error code along with a message describing the error.
- If you are adding multiple devices and one or more of the device installation code is missing or incorrect, you receive an HTTP status 207 error along with a message describing the error.
devMac
MAC address for the device.
devRecordStartDate
Date the device record was created.
devTerminated
False if the device is currently in the customer account.
dpConnectionStatus
Connection status for the device
| Value | Description |
|---|---|
| 0 | Disconnected |
| 1 | Connected |
dpContact
Contact setting from the device.
dpCurrentConnectPw
Password for the device to connect to OEM Cloud. If set, the device must provide the password to connect.
dpDescription
Description setting from the device.
dpDeviceType
Manufacturer-assigned device type, such as ConnectPort X2.
dpFirmwareLevel
Integer that represents the firmware level. For example, 34209795.
dpFirmwareLevelDesc
String value that represents the firmware level. For example, 2.10.0.3.
dpGlobalIp
IP address from which the device connected in IPv4 format.
dpLastConnectTime
Date the device last connected to OEM Cloud. For example, 2010-07-21T15:20:00Z.
dpLastKnownIp
IP address last reported by the device in IPv4 format.
dpLocation
Location setting from the device.
dpMapLat
Map latitude setting from the device.
dpMapLong
Map longitude setting from the device.
dpPanId
PanId setting from the device.
dpRestrictedStatus
Indicates restrictions on the device for connecting to OEM Cloud:
| Value | Description |
|---|---|
| 0 | Unrestricted |
| 2 | Restricted |
| 3 | Untrusted |
dpRestrictedStatus can be set using POST or PUT.
dpServerId
Identifier of the server to which the device is currently connected.
dpTags
Comma-delimited set of user-defined tags.
dpUserMetaData
User-specified free-form text field.
dvVendorId
Identifier of the manufacturing vendor.
grpId
System-generated identifier for the customer group.
grpPath
Full path name of the specified group. For PUT or POST requests, if the specified group does not exist, OEM Cloud creates the group.
id
Unique identifier for the device that consists of the following elements:
- devId: System-generated identifier for the device.
- devVersion: Version for the device. A value of 0 indicates the most current version.
provisionId
Randomly-generated identifier used to provision the device. This identifier must be used in place of devConnectwareId and you must supply a vendor ID.
xpExtAddr
ZigBee extended address from the device.