NameDescriptionTypeAdditional information
CLI

The MSISDN or IMSI of the SIM. This is the unique identifier for a SIM

string

Required

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

SIMNumber

Gets and sets the ICCID of the SIM - this is optional

string

None.

Description

Gets and sets the optional description of the SIM

string

None.

InventoryRef

An optional inventory reference. This is just stored and returned to the api caller as needed

string

None.

State

Gets and sets the SIM state. This can be of the following values:-<br/><br/> notactivated = 0 ready = 1 test = 2 live = 3 suspend = 4 bar = 5 unknown = 6 terminated = 100

SimCardStateValues

None.

Version

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

integer

None.

ActorStatus

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

ForeignAttributes

This holds optional extra details about the SIM that may be required for example to drive an underlying SIM management api

Dictionary of string [key] and string [value]

None.

Tariff

Gets and sets the tariff the SIM is set to on the operators platform. Support for this is dependent on the operator and the integration.

string

None.

Bundle

Gets and sets the bundle the SIM is set to on the operators platform. Support for this is dependent on the operator and the integration.

string

None.

Operator

Gets and sets the operator that the SIM is belongs too

string

None.

Hints

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

AccountHints

None.

NetworkStatus

Gets the connection status of the SIM on the operator network. Support for this is dependent on the operator and the integration. It can be one of the following values:- <br/> disconnected = 0 connected = 1 activation = 10

NetworkStatusValues

None.

Created

Gets the date the SIMCard was created on the API

date

None.

SOC

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

string

None.

InternalSOC

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

string

None.

PurchaseOrder

Gets and sets the purchase order number associated with the SIMCard when is was purchased. This is optional and dependent on the billing arrangements.

string

None.

Provider

Gets and sets the name of the entity that provided the SIMCard. This is optional and dependent on the billing arrangements.

string

None.

ProviderTariff

Gets and sets the tariff applied by the SIMCard provider. This is optional and dependent on the billing arrangements.

string

None.

ProviderPrice

Gets and sets the price applied by the SIMCard provider. This is optional and dependent on the billing arrangements.

string

None.

ProviderStartDate

Gets and sets the date the SIMCard is considered billable by the SIMCard provider. This is optional and dependent on the billing arrangements.

date

None.