Reference

Endpoint

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

The following is a sample endpoint in JSON representation. Apart from the endpoint-specific data, it contains the following embedded objects:

  • service_profile
  • tariff_profile
  • sim
  • runtime_data
1{
2  "id": 1,
3  "name": "arduino01",
4  "tags": "arduino, meter, temp",
5  "created": "2014-08-01T08:47:00+00:00",
6  "last_updated": "2016-03-02T15:25:34.000+0000",
7  "status": {
8    "id": 0,
9    "description": "Enabled"
10  },
11  "service_profile": {
12    "id": 1,
13    "name": "Smart Meter"
14  },
15  "tariff_profile": {
16    "id": 3,
17    "name": "Domestic only"
18  },
19  "sim": {
20    "id": 788,
21    "iccid": "7368267364738977362",
22    "iccid_with_luhn": "73682673647389773621",
23    "eid": "89049011803455664400046832584675",
24    "imsi": "901991234567890",
25    "msisdn": "88563748761",
26    "status": {
27      "id": 1,
28      "description": "Activated"
29    }
30  },
31  "runtime_data": {
32    "msc": "491790802121",
33    "sgsn": "491752345678",
34    "sgsn_ip_address": "82.113.96.21"
35  },
36  "imei": "8643456788893212",
37  "imei_with_luhn": "864345678889324",
38  "ip_address": "10.2.1.1",
39  "ip_address_space": {
40    "id": 2,
41    "ip_address_space": "10.2.0.0/16",
42    "ip_address_version": 4
43  },
44  "imei_lock": true
45}

Endpoint object

The endpoint object has the following properties:

NameTypeDescription
idIntegerUnique identifier of this endpoint
nameStringName of endpoint
tagsString | nullAny tags assigned to this endpoint with each value separated by a comma (for example, "arduino, meter, temp")
createdTimestampDate/time when this endpoint was created
Type: ISO 8601 timestamp format
last_updatedTimestampDate/time when this endpoint was last updated
Type: ISO 8601 timestamp format
statusObjectInformation about the endpoint status (see Endpoint status object)
service_profileObject | nullDetails about the assigned service profile (see Service profile object)
tariff_profileObject | nullDetails about the assigned tariff profile (see Tariff profile object)
simObject | nullInformation about the SIM card used by the endpoint (see SIM object)
runtime_dataObjectInformation about the runtime data for this endpoint (see Runtime data object)
imeiString | null16-digit international mobile equipment identity without the check digit. The last two digits identify the Software Version Number (SVN).
imei_with_luhnString | null15-digit international mobile equipment identity. The last digit contains the check digit.
ip_addressStringConfigured IP address
ip_address_spaceObjectInformation about the assigned IP address space (see IP Address Space Object)
imei_lockBooleanWhether or not the endpoint is locked to the current IMEI

Endpoint status object

PropertyTypeDescription
idIntegerStatus ID for this endpoint
descriptionStringDescription of the endpoint status

Endpoint statuses

IDDescription
0Enabled
1Disabled
2Deleted

Service profile object

This data is embedded from a subset of the Service profile.

PropertyTypeDescription
idNumberUnique identifier of the assigned service profile
nameStringName of the service profile

Tariff profile object

This data is embedded from a subset of the Tariff profile.

PropertyTypeDescription
idNumberUnique identifier of the assigned tariff profile
nameStringName of the tariff profile

SIM Object

This data is embedded from a subset of the SIM.

PropertyTypeDescription
idIntegerUnique identifier of this SIM
iccidStringIntegrated circuit card identifier without the final Luhn checksum digit
iccid_with_luhnStringIntegrated circuit card identifier including the final Luhn checksum digit
eidStringUnique global serial number for an eUICC if applicable
imsiString | nullCurrently active IMSI number of this SIM
msisdnString | nullMSISDN number assigned to this SIM
statusObjectInformation about the SIM status (see SIM status object)

Runtime data object

PropertyTypeDescription
mscStringGlobal title of the MSC connected to this endpoint
sgsnStringGlobal title of the serving GPRS support node (SGSN)
sgsn_ip_addressStringIP of the SGSN currently serving this endpoint

IP address space object

PropertyTypeDescription
idIntegerUnique identifier of the assigned IP address space
ip_address_spaceStringSubnet of the IP address space
ip_address_versionIntegerIP version for this address space (for example, 4 or 6)