API Reference

RAN Provider REST APIs provide direct data access to Base Station information for use in external monitoring and reporting.

Base Station Status API

The Base Station Status API returns detailed information for a set of Base Stations. This may include details about the Base Station like model type, version and uptime as well as current connection information.

There are 2 status sources supported by this API, that are selected using the required parameter.

Resource URL

https://api.senetco.io/rest/integration/bstn/details

Parameters

Parameter Name Description Required Default Value Allowed Values
eui The IEEE EUI-64 identifier for the Base Station. Used to limit the returned data to a specific EUI. No
status The type of status data to use as a source.
Alarm=Retrieve Base Stations only .with open alarms.
Any=Retrieve Base Stations with or without open alarms
Yes alarm, any
fields A comma separated list of fields names to return in the data set. Used to return a smaller subset of data than the default.
Supported Fields:
"status,lastContact,lastPacket,name,model,ismBandName,version,uptime,radius,antennaHeight,alertLevel,deltaTime,address,"
"location,gpsLocation,gpsAltitude"
No All Fields Any combination of the supported fields

Curl Examples

Status for Base Stations with Open Alarms.

curl -H "authorization: <API_KEY_TO_USE>" --insecure -X POST "https://api.senetco.io/rest/integration/bstn/details?status=alarm" 

Status for a specific Base Station with Open Alarms.

curl -H "authorization: <API_KEY_TO_USE>" --insecure -X POST "https://api.senetco.io/rest/integration/bstn/details?status=alarm&eui=AAAAAAAAAAAAAAAA"

Status for Base Stations with or without Open Alarms.

curl -H "authorization: <API_KEY_TO_USE>" --insecure -X POST "https://api.senetco.io/rest/integration/bstn/details?status=any"

Status for a Base Station with or without Open Alarms, only return fields "status" and "lastContact".

curl -H "authorization: <API_KEY_TO_USE>" --insecure -X POST "https://api.senetco.io/rest/integration/bstn/details?status=any&eui=AAAAAAAAAAAAAAAA&fields=status,lastContact"

Response Examples

For a single Base Station all fields:

{
   "data":[
      {
         "eui":"AAAAAAAAAAAAAAAA",
         "status":{
            "color":"orange",
            "connIssues":"Connection Issues: No SSH",
            "alertCount":1
         },
         "lastContact":1550691020270,
         "lastPacket":1550691080252,
         "name":"Sample BSTN",
         "model":"MultiTech Conduit AP",
         "ismBandName":"US902-928:Default",
         "version":"02_04_04",
         "uptime":30187974,
         "radius":10,
         "antennaHeight":15.01,
         "alertLevel":"Level 1",
         "deltaTime":41,
         "location":{
            "latitude":43.083412,
            "longitude":-70.77599
         },
         "gpsLocation":{
            "latitude":"43.07851",
            "longitude":"-70.7583"
         },
         "gpsAltitude":"32.16134"
      }
   ]
}

Multiple Base Stations with only the "status,lastContact" fields.

{
   "data":[
      {
         "eui":"AAAAAAAAAAAAAAAA",
         "status":{
            "color":"orange",
            "connIssues":"Connection Issues: No SSH",
            "alertCount":1
         },
         "lastContact":1550691020270
      },
      {
         "eui":"AAAAAAAAAAAAAAAA",
         "status":{
            "color":"red",
            "connIssues":"No Issues",
            "alertCount":2
         },
         "lastContact":1550691020354
      }
   ]
}