Table of Contents

API : Network Device Model Create

Introduction

This request will create a network device model. The picture is set separately with Upload picture.

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 - 2-100 characters.
type String Type of device: ROUTER, SWITCH, ACCESS_POINT, FIREWALL, MODEM, OTHER.
description String A short description of the device model and its capabilities - max 500 characters.
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”.

Body example

{
  "brand": "TP-LINK",
  "name": "XVS-200",
  "type": "ROUTER",
  "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 Type of device: ROUTER, SWITCH, ACCESS_POINT, FIREWALL, MODEM, OTHER.
picture Id Id of picture of the device on image.telecomx.dk. Absent on a newly created model - set via Upload picture.
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

{
  "_id": "12345678901234567890ABCC",
  "brand": "TP-LINK",
  "name": "XVS-200",
  "type": "ROUTER",
  "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
404 <field> A required body field is missing.
422 <field> A field value is invalid.
500 internal_error <Unspecified>