Table of Contents

API : Network Device Model Create

Introduction

This request will create a network device model.

Request

URL https://api.telecomx.dk/network/device/model
Method POST
Access level RESELLER_ADMIN or ADMIN.
Property Type Description
Body brand String Name of brand: TP-LINK.
name String Name of device model.
type String Type of device: ROUTER, SWITCH, FIREWALL, ACCESSPOINT, 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 wifi.
capabilities.wifi5G Boolean True if the device model supports wifi.
capabilities.wifi6G Boolean True if the device model supports wifi.
capabilities.simSupport Boolean Supports SIM-card. Only relevant if type = “ROUTER”.

Body example

{
  "_id": "1234567890123457890ABCC",
  "brand": "TP-LINK",
  "name": "XVS-200",
  "type: "ROUTER",
  "picture": "1234578901234567890ABCD",
  "description": "5G router with 2,4/5Ghz wifi and ethernet.",
  "capabilities": {
    "wifi": true,
    "wifi2G": true,
    "wifi5G": true,
    "wifi6G": false,
    "simSupport": true
  }
}

Response

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
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 wifi.
capabilities.wifi5G Boolean True if the device model supports wifi.
capabilities.wifi6G Boolean True if the device model supports 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

{
  "_id": "1234567890123457890ABCC",
  "brand": "TP-LINK",
  "name": "XVS-200",
  "type: "ROUTER",
  "picture": "1234578901234567890ABCD",
  "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
409 type Value is not one of the permitted values.
403 access_denied Insufficient access level
500 internal_error <Unspecified>