Name | Description | Type | Additional information |
---|---|---|---|
DeviceUniqueId |
The unique device identifier |
string |
Required |
CertificateNames | Collection of string |
None. |
|
SOC |
Gets and sets the SOC code assigned to the IOTDevice by the API consumer. This is optional and dependent on the billing arrangements. |
string |
None. |
StartDate |
Gets the date the IOTDevice was created on |
date |
None. |
EndDate |
Get the date the IOTDevice was removed on |
date |
None. |
FriendlyName |
Gets and sets an optional friendly name for the device |
string |
None. |
Version |
The version of the IOTDevice actor. Every time a change is made to the IOTDevice its version is incremented. |
integer |
None. |
ActorStatus |
The IOTDevice actor status. Every resource in the api is represented by an actor. The actor status represents the health of the resource. The ActorStatus can be one of the following values:-<br/> stable = 0 /* everything is ok */ pending = 1 /* an operation is long running */ stalled = 10 /* an unrecoverable error has occurred that will require support desk intervention */ |
ActorStatusValues |
None. |
ProvisioningMetaData |
Gets and sets optional provisioning data that may be required to be suppled on IOTDevice creation. This will depend on the integration |
Dictionary of string [key] and string [value] |
None. |
Hints |
The Hints allow the auto creation of the Account resource. If the account doesn't exist when a IOTDevice is created the Hints can contain information to assist in auto created the Account resource. |
AccountHints |
None. |
InternalSOC |
The SOC code assigned to the IOTDevice by the Asavie. This is optional and dependent on the billing arrangements. |
string |
None. |
IPAddress |
Gets the IP address assigned to the device. Depending on the topology of the AccountNetwork the device is a member of this may not be applicable |
string |
None. |
Status | StatusValues |
None. |
|
NetworkStatus |
Gets the connection status of the device to the Passbridge core. It can have one of the following values:-<br/><br/> disconnected = 0 connected = 1 activation = 10 |
NetworkStatusValues |
None. |
Enabled |
Gets and sets whether the APNDeivce is enabled or disabled on the Passbridge Core |
boolean |
None. |
LastSync | date |
None. |