NameDescriptionTypeAdditional information
CLI

The MSISDN or IMSI for the device.

string

Required

Matching regular expression pattern: ^(?<msisdn>\(\+*(\d{1,5})\)(\d{5,16}))$|^(?<imsi>\d{14,16})$

SIMNumber

Gets and sets the ICCID for the device

string

None.

SOC

Gets and sets the SOC code assigned to the APNDevice by the API consumer. This is optional and dependent on the billing arrangements.

string

None.

InternalSOC

The SOC code assigned to the APNDevice by the Asavie. This is optional and dependent on the billing arrangements.

string

None.

Description

Gets and sets an optional description for the device

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.

StartDate

Gets the date the APNDevice was created

date

None.

EndDate

Gets the date the APNDevice was removed

date

None.

FriendlyName

Gets and sets an optional friendly name for the device

string

None.

Hints

The Hints allow the auto creation of the Account resource. If the account doesn't exist when a APNDevice is created the Hints can contain information to assist in auto created the Account resource.

AccountHints

None.

ProvisioningMetaData

Gets and sets optional provisioning data that may be required to be suppled on APNDevice creation. This will depend on the integration

Dictionary of string [key] and string [value]

None.

Status

StatusValues

None.

Version

The version of the Agent actor. Every time a change is made to the Agent its version is incremented.

integer

None.

ActorStatus

The APNDevice 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.

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.

LockIMEI

Gets and sets the IMEI locking status. If set to true then the next time the device connects to the Passbridge core its IMEI will be recorded. From then on the device will only be allowed connect if it has the same IMIE

boolean

None.

IMEI

Gets the devices IMEI (only available if IMEI locking has been enabled)

string

None.

LastSync

date

None.

LastConnected_Start

Gets the date and time of the start of the last session the device established with the Passbridge core

date

None.

LastConnected_End

Gets the date and time of the end of the last session the device established with the Passbridge core

date

None.

LastConnected_MCC

Get the MCC of the last session the device established with the Passbridge core.

string

None.

LastConnected_MNC

Gets the MNC of the last session the device established with the Passbridge core

string

None.