Table of Contents

API : SIM: Simcard inventory

Introduction

This request will return simcard inventory statistics.

Request

URL https://api.telecomx.dk/sim/status
Method GET
Access level RESELLER_ADMIN, ADMIN

Query example

https://api.telecomx.dk/sim/status

Response

Field Type Description
inStorageAt ObjectId ID of customer these SIM-cards are assigned to. Null if not assigned to anyone.
inStorageAtName String Name of the customer these SIM-cards are assigned to. 'Centrallager' when not assigned to anyone.
reseller ObjectId Reseller ID of customer these SIM-cards are assigned to. Null if not assigned to anyone.
resellerName String Reseller name of customer these SIM-cards are assigned to. Null if not assigned to anyone.
network Object Object with the mobile networks being keys. Contains SIM-card stats for each network. TDC and TELENOR are always both present
network[key].total Number Total amount of SIM-cards on this network.
network[key].eSIM Number Amount of eSIM cards
network[key].eSIM_SMARTWATCH Number Amount of eSIM smartwatch cards
network[key].MINI_MICRO Number Amount of MINI_MICRO cards
network[key].MINI_MICRO_NANO Number Amount of MINI_MICRO_NANO cards.
network[key].NANO Number Amount of NANO cards
network[key].autoAssign Number Amount of SIM-cards tagged as autoAssign
network[key].nonAutoAssign Number Amount of SIM-cards tagged as non-autoAssign

Example

[
  {
    "reseller": null,
    "inStorageAt": null,
    "inStorageAtName": "Centrallager",
    "network": {
      "TDC": {
        "total": 1200,
        "autoAssign": 0,
        "nonAutoAssign": 1200,
        "MINI_MICRO_NANO": 200,
        "eSIM": 1000
      },
      "TELENOR": {
        "total": 600,
        "autoAssign": 0,
        "nonAutoAssign": 600,
        "NANO": 300,
        "MINI_MICRO": 100,
        "MINI_MICRO_NANO": 200
      }
    }
  },
  {
    "reseller": "650000000000000000000201",
    "resellerName": "Example Reseller",
    "inStorageAt": "650000000000000000000201",
    "inStorageAtName": "Example Reseller",
    "network": {
      "TDC": {
        "total": 900,
        "autoAssign": 0,
        "nonAutoAssign": 900,
        "eSIM": 900
      },
      "TELENOR": {
        "total": 30,
        "autoAssign": 10,
        "nonAutoAssign": 20,
        "MINI_MICRO": 10,
        "NANO": 20
      }
    }
  }
]

Errors

Error code Message Description
403 access_denied Insufficient access level
500 internal_error <Unspecified>