Table of Contents

API : Network Device Model List

Introduction

This request will return the list of all network device models.

Request

URL https://api.telecomx.dk/network/device/model
Method GET
Access level VIEWER, MANAGER, OWNER, RESELLER, RESELLER_ADMIN or ADMIN.
Property Type Description
Query offset Number Index of first item to return, default 0.
limit Number Max number of items to return, default 100, max 500.

Query examples

https://api.telecomx.dk/network/device/model

Response

JSON object
Property Type Description
offset Number Index of the first network device model returned.
limit Number Number of network device models to return. Note that the actual number of items returned may be lower.
total Number Number of network device models that can be returned when offset and limit is not considered. This is to be used for paging through the data.
networkDeviceModels Array List of network device models, see definition below.
Network device model
Property Type Description
_id Id Unique id of the device model.
brand String Name of brand: TP-LINK.
name String Name of device model.
type String Type of device: ROUTER, SWITCH, ACCESS_POINT, FIREWALL, MODEM, OTHER.
picture Id Id of picture of the device on image.telecomx.dk, 256×256 pixels or larger.
description String A short description of the device model and its capabilities.
capabilities Subsection with device capabilities
capabilities.wifi Boolean True if the device model supports wifi.
capabilities.wifi2G Boolean True if the device model supports 2.4GHz wifi.
capabilities.wifi5G Boolean True if the device model supports 5GHz wifi.
capabilities.wifi6G Boolean True if the device model supports 6GHz wifi.
capabilities.simSupport Boolean Supports SIM-card. Only relevant if type = “ROUTER”.

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

Example

{
  "offset": 0,
  "limit": 100,
  "total": 1,
  "networkDeviceModels": [
    {
      "_id": "12345678901234567890ABCC",
      "brand": "TP-LINK",
      "name": "XVS-200",
      "type": "ROUTER",
      "picture": "12345678901234567890ABCD",
      "description": "5G router with 2,4/5Ghz wifi and ethernet.",
      "capabilities": {
        "wifi": true,
        "wifi2G": true,
        "wifi5G": true,
        "wifi6G": false,
        "simSupport": true
      }
    }
  ]
}

Errors

Error code Message Description
403 access_denied Insufficient access level
422 <param> A query parameter is invalid.
500 internal_error <Unspecified>