SIM
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.
The following is a sample SIM in JSON representation.
Apart from its own data, the object contains an embedded endpoint object.
1 { 2 "id": 788, 3 "iccid": "8988303000008013931", 4 "iccid_with_luhn": "89883030000080139311", 5 "eid": "89049011803455664400046832584675", 6 "production_date": "2014-08-01T08:47:00+0000", 7 "activation_date": "2014-08-21T18:17:00+0000", 8 "status": { 9 "id": 1, 10 "description": "Activated" 11 }, 12 "customer_org": { 13 "id": 13, 14 "name": "Enterprise", 15 "country": { 16 "id": 205, 17 "name": "United Kingdom" 18 } 19 }, 20 "issuer_org": { 21 "id": 11, 22 "name": "MNO", 23 "country": { 24 "id": 205, 25 "name": "United Kingdom" 26 } 27 }, 28 "reseller_org": null, 29 "endpoint": { 30 "id": 1, 31 "name": "arduino01", 32 "imei": "864345678889321", 33 "created": "2015-03-19T08:45:41.000+0000", 34 "last_updated": "2015-03-19T08:45:41.000+0000", 35 "organisation_id": 5, 36 "service_profile_id": 1, 37 "tariff_profile_id": 1, 38 "tags": "arduino, meter, temp", 39 "ip_address": "10.1.1.9", 40 "ip_address_space_id": 1 41 }, 42 "imsi": "123451234567890", 43 "msisdn": "88563748761", 44 "model": { 45 "id": 1, 46 "description": "Java smartcard", 47 "memory_size": 64, 48 "formfactor": { 49 "id": 1, 50 "name": "2FF", 51 }, 52 "manufacturer": { 53 "id": 1, 54 "name": "Motorola" 55 } 56 } 57 }
SIM object
Here is the description of SIM object:
| Property | Type | Description |
|---|---|---|
id | Number | Unique identifier of this SIM |
iccid | String | Integrated circuit card identifier without the final Luhn checksum digit |
iccid_with_luhn | String | Integrated circuit card identifier including the final Luhn checksum digit |
eid | String | Unique global serial number for an eUICC if applicable |
production_date | Timestamp | null | Date/time when this SIM was created Type: ISO 8601 timestamp format |
activation_date | Timestamp | null | Date/time when this SIM was activated for the first time Type: ISO 8601 timestamp format |
status | Object | Information about the SIM status (see SIM status object) |
customer_org | Object | Details about the organization the SIM is issued to (see Customer organization object) |
issuer_org | Object | Details about the organization that issued the SIM (see Issuer organization object) |
reseller_org | Object | null | Details about the organization that resold the SIM (see Reseller organization object) |
endpoint | Object | null | Details about the endpoint the SIM is assigned to (see Endpoint object) |
imsi | String | null | IMSI number of the SIM |
msisdn | String | null | MSISDN number of the SIM |
model | Object | null | Details about the SIM model (see Model object) |
SIM status object
| Property | Type | Description |
|---|---|---|
id | Number | Status ID for this SIM |
description | String | Description of the SIM status |
SIM statuses
| ID | Description |
|---|---|
| 0 | Issued |
| 1 | Activated |
| 2 | Suspended |
| 3 | Deleted |
| 4 | Factory Test |
Customer organization object
| Property | Type | Description |
|---|---|---|
id | Number | Unique identifier of the organization |
name | String | Name of the organization |
country | Object | Country of the organization (see Country object) |
Issuer organization object
| Property | Type | Description |
|---|---|---|
id | Number | Unique identifier of the organization |
name | String | Name of the organization |
country | Object | Country of the organization (see Country object) |
Reseller organization object
| Property | Type | Description |
|---|---|---|
id | Number | Unique identifier of the organization |
name | String | Name of the organization |
country | Object | Country of the organization (see Country object) |
Country object
| Property | Type | Description |
|---|---|---|
id | Integer | Unique identifier of the country |
name | String | Name of country |
Endpoint object
This data is embedded from a subset of the Endpoint.
| Property | Type | Description |
|---|---|---|
id | Integer | Unique identifier of the endpoint |
name | String | Name of endpoint |
imei | String | null | International mobile equipment identity |
created | Timestamp | Date/time when this endpoint was created Type: ISO 8601 timestamp format |
last_updated | Timestamp | Date/time when this endpoint was last updated Type: ISO 8601 timestamp format |
organisation_id | Integer | Unique identifier of the organization assigned to the endpoint |
service_profile_id | Integer | null | Unique identifier of the assigned service profile |
tariff_profile_id | Integer | null | Unique identifier of the assigned tariff profile |
tags | String | null | Any tags assigned to this endpoint with each value separated by a comma (for example, "arduino, meter, temp") |
ip_address | String | Configured IP address |
ip_address_space_id | Integer | Unique identifier of the assigned IP address space |
Model object
| Property | Type | Description |
|---|---|---|
id | Integer | Unique identifier of the SIM model |
description | String | Description of the SIM model |
memory_size | Integer | Memory size in KB |
formfactor | Object | Details about the SIM form factor (see Form factor object) |
manufacturer | Object | Manufacturer of the SIM (see Manufacturer object) |
Form factor object
| Property | Type | Description |
|---|---|---|
id | Integer | Form factor ID for this SIM |
name | String | Description of the form factor |
Manufacturer object
| Property | Type | Description |
|---|---|---|
id | Integer | Unique identifier of the manufacturer |
name | String | Name of the manufacturer |
