Endpoints
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.
Below is the sample endpoint in JSON representation. Apart from its own data, the object contains embedded objects:
service_profile
tariff_profile
sim and
runtime_data
{
"id": 1,
"name": "arduino01",
"tags": "arduino, meter, temp",
"created": "2014-08-01T08:47:00+00:00",
"last_updated": "2016-03-02T15:25:34.000+0000",
"status": {
"id": 0,
"description": "Enabled"
},
"service_profile": {
"id": 1,
"name": "Smart Meter"
},
"tariff_profile": {
"id": 3,
"name": "Domestic only"
},
"sim": {
"id": 788,
"iccid": "736826736473829773621",
"imsi": "901991234567890",
"msisdn": "+88563748761"
},
"imei": "864345678889321",
"imei_lock": true,
"ip_address": "10.2.1.1",
"ip_address_space": {
"id": 2,
"ip_address_space": "10.2.0.0/16",
"ip_address_version": 4
},
"runtime_data": {
"msc": "491790802121",
"sgsn": "491752345678",
"sgsn_ip_address": "82.113.96.21"
}
}
Endpoint Object
The endpoint object has the following properties:
Name | Type | Description |
---|---|---|
id | Integer | Unique ID of this endpoint |
name | String | Name of endpoint |
tags | String | Assigned Tags |
created | Timestamp | Timestamp when this endpoint was created (ISO 8601 timestamp format) |
last_updated | Timestamp | Timestamp when this endpoint was updated last time (ISO 8601 timestamp format) |
status | Object | id (Integer) - ID of status this endpointdescription (String) - description of meaning of the status |
service_profile | Object | id (Integer) - ID of assigned service profilename (String) - name of the service profile |
tariff_profile | Object | id (Integer) - ID of assigned tariff profilename (String) - name of the tariff profile |
image | String | File name of image to display for this endpoint |
sim | Object | id (Integer) - ID of SIM cardiccid (String) - ICCID of SIM cardimsi (String) - currently active IMSI on this SIM cardmsisdn (String) - MSISDN assigned to this SIM card |
imei | String | IMEI number of device in use |
imei_lock | boolean | Is the endpoint locked to the current IMEI or not |
ip_address | String | Configured IP address |
ip_address_space | Object | id (Integer) - ID of assigned ip address spaceip_address_space (String) - subnet of the IP address spaceip_address_version (Interger) - IP version for this address space, e.g. 4 or 6 |
runtime_data | Object | msc (String) - global title of MSC this endpoint is connected tosgsn (String) - global title of the serving SGSNsgsn_ip_address (String) - IP of SGSN currently serving this endpoint |