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/simstatus

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 customer these SIM-cards are assigned to. Null if 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
network[key].total	Number	Total amount of SIM-cards on this network.
network[key].eSim	Number	Amount of eSIM 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": 0,
                "autoAssign": 0,
                "nonAutoAssign": 1200,
                "MINI_MICRO_NANO": 200,
                "eSIM": 1000
            },
            "TELENOR": {
                "total": 0,
                "autoAssign": 0,
                "nonAutoAssign": 1600,
                "NANO": 300,
                "MINI_MICRO": 100,
                "MINI_MICRO_NANO": 200
            }
        }
    },
        {
        "reseller": "61f4fd7734697b28ccaf89ff",
        "resellerName": "Mobile Reseller ApS",
        "inStorageAt": "61f4fd7734697b28ccaf89ff",
        "inStorageAtName": "Mobile Reseller ApS",
        "network": {
            "TDC": {
                "total": 0,
                "autoAssign": 0,
                "nonAutoAssign": 900,
                "eSIM": 900
            },
            "TELENOR": {
                "total": 0,
                "autoAssign": 0,
                "nonAutoAssign": 30,
                "MINI_MICRO": 10,
                "NANO": 20
            }
        }
    },
]

Errors

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

WIKI

Table of Contents

API : SIM: Simcard inventory

Introduction

Request

Query example

Response

Example

Errors