SIMs

The API provides services to retrieve the collection of SIMs with paging, filtering and sorting options. It also provides services for single SIM retrieval and CRUD operations via POST, PATCH and DELETE actions.

Below is the sample SIM in JSON representation. Apart from own data, the object contains embedded objects:

  • model
  • endpoint
{
  "id": 788,
  "iccid": "736826736473829773621",
  "production_date": "2014-08-01T08:47:00+0000",
  "activation_date": "2014-08-21T18:17:00+0000",
  "status": {
    "id": 1,
    "description": "Active"
  },
  "customer_org":{
    "id": 13,
    "name": "Enterprise",
    "country":{
      "id":205,
      "name":"United Kingdom"
    }
  },
  "issuer_org":{
    "id": 11,
    "name": "MNO",
    "country":{
      "id":205,
      "name":"United Kingdom"
    }
  },
  "endpoint": {
    "id": 1,
    "name": "arduino01",
    "imei": null,
    "imei_lock": false,
    "created": "2015-03-19T08:45:41.000+0000",
    "last_updated": "2015-03-19T08:45:41.000+0000",
    "organisation_id": 5,
    "service_profile_id": 1,
    "tariff_profile_id": 1,
    "tags": null,
    "ip_address": "10.1.1.9"
  },
  "imsi": "123451234567890",
  "msisdn": "+88563748761",
  "model": {
    "id": 1,
    "description": "Java smartcard",
    "memory_size": 64,
    "formfactor": {
      "id": 1,
      "name": "2FF",
      "image": "2ff.jpg"
    },
    "manufacturer": {
      "id": 1,
      "name": "Motorola"
    }
  }
}

SIM Object

Here is the description of SIM object:

Name Type Description
id Integer Unique ID of this SIM
iccid String integrated circuit card identifier
production_date Timestamp Timestamp when this SIM was created
- Type: ISO 8601 timestamp format
activation_date Timestamp Timestamp when this SIM was activated for the first time
- Type: ISO 8601 timestamp format
status Object id (Integer) - ID of status this SIM
description (String) - Description of meaning of the status
customer_org Object id (Integer) - ID of the organisation to whom the sim was issued
name (String) and country (Object) of that organisation
issuer_org Object id (Integer) - ID of the organisation who issued the sim
name (String) and country (Object) of that organisation
reseller_org Object id (Integer) - ID of the organisation who resold the sim
name (String) and country (Object) of that organisation
endpoint Object id (Integer) - ID of associated endpoint
name (String) - endpoint name
some more collapsed information of the endpoint -> Endpoint
imsi String IMSI number of the SIM
msisdn String MSISDN number of the SIM
model Object id (Integer) - ID of the SIM model
description (String) - Description of the model
memory_size (Integer) - Memory Size in KB
form factor (Object) - SIM form factor
manufacturer (Object) - manufacturer of the SIM