API : Network Devices Admin List

Introduction

This request will return the list of all network devices that an admin has access to.

Request

URL	https://api.telecomx.dk/network/device/admin
Method	GET
Access level	RESELLER_ADMIN ADMIN.
Query	filter	`[optional]` Can filter by: name of the device, name of customer and reseller, mac address and serial number
	status	`[optional]` Status of the device: no_sim for devices without a SIM card, missing_mvno_account for devices with an active SIM card which belongs to a MVNO-account we don't know
	offset	`[optional]` Index of first item to return. Defaults to 0.
	limit	`[optional]` Number of items to return, max 500. Defaults to 100.

Query examples

https://api.telecomx.dk/network/device/admin
https://api.telecomx.dk/network/device/admin?status=no_sim

Response

JSON object
Property	Type	Description
offset	Number	Index of the network device returned.
limit	Number	Number of network devices to return. Note that the actual number of items returned may be lower.
total	Number	Number of network devices that can be returned when offset and limit is not considered. This is to be used for paging through the data.
networkDevices	Array	List of network devices, see definition below.

Network device
Property	Type	Description
_id	Id	Unique id of the device.
state	String	Which state the device is in: ACTIVE, PROVISIONING, DELETING.
name	String	Name of device
model	Id	Id of network device
modelType	String	Model type
modelBrand	String	Brand name
modelPicture	Id	Id of picture of the device model, on the image servers.
resellerName	String	Name of the reseller for the customer
customerName	String	Name of the customer which has the device
customer	ObjectId	Id of the customer which has the device
activeSim	String	SIM card used in the device
mvnoAccount	ObjectId	Id of the voice account related to the SIM card
macAddress	String	MAC address
serialNumber	String	Serial number of the device
jobs	Number	Number of provisioning jobs currently in progress.
provisioned	Boolean	True if the device is provisioned.
lastComm	Date	Timestamp of the last time this device was communicated with, either directly or through a third-party service
online	Boolean	True if the device is online.

Note that properties holding no value may be omitted from the object.

Example - normal

{
  "offset": 10,
  "limit": 20,
  "total": 123,
  "networkDevices":
  [
    {
      "id": ObjectId("1234567890ABCD1234567890"),
      "state": "ACTIVE",
      "name": "My Primary Router",
      "model": "1234567890ABCD1234567890",
      "modelType": "ROUTER",,
      "modelBrand": "TP-Link",
      "modelDescription": "TP-Link NX220v",
      "modelPicture": "1234567890ABCD1234567890",
      "resellerName": "Mikkel forhandler",
      "customerName": "Mikkel kunde",
      "customer": ObjectId("2234567890ABCD1234567890"),
      "activeSim": "1235hejmedig321",
      "mvnoAccount": ObjectId("3234567890ABCD1234567890"),
      "macAddress": "00:4A:57:21:D9:01",
      "serialNumber": "NXQ26699371",
      "jobs": 0,
      "provisioned:" true,
      "lastComm": Date,
      "online": true,
     },
    {
      ...
    }
  ]
}

Errors

Error code	Message	Description
403	access_denied	Insufficient access level
404	customer	Not found
500	internal_error	<Unspecified>

WIKI

Table of Contents

API : Network Devices Admin List

Introduction

Request

Query examples

Response

Example - normal

Errors