API : SIM Get

Introduction

This request will return a SIM card.

Request

URL	https://api.telecomx.dk/sim/SIM_ID
Method	GET
Access level	VIEWER and up if the user's customer holds the SIM in storage, or the SIM is not in storage at anyone. RESELLER_ADMIN and ADMIN for any SIM.
Param	SIM_ID	SIM card number (ICC), 19-20 digits with an optional single trailing letter (specific Telenor SIMs). The letter is ignored for the lookup and echoed back in the response.

Query example

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

Response

JSON object
_id	String	SIM card number (ICC).
imsi	String	IMSI number.
puk1	String	PUK 1 code.
puk2	String	PUK 2 code.
pin1	String	PIN 1 code.
pin2	String	PIN 2 code.
formFactor	String	Physical size of the SIM card: MINI_MICRO, NANO, MINI_MICRO_NANO, eSIM or eSIM_SMARTWATCH.
network	String	The network the SIM card is for: TELENOR or TDC
inStorageAt	Id	Id of the customer or reseller where the SIM card is in storage at. Null if Held by Telecom X.
activationCode	String	eSIM activation code.
tag	String	Tag for pool selection.
lastChecked	Date	Date when the SIM availability was last checked.
willBeUsedBy	Id	Id of MVNO account that has reserved this SIM.
autoAssign	Boolean	If this is an “auto-assign” SIM. When new MVNO accounts are created on the reseller's customer, this SIM can be automatically assigned to the MVNO. Can be used by resellers who has a storage of SIM cards.

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

Example - normal

{
  "_id": "8945000000000000001",
  "imsi": "238010000000001",
  "puk1": "587896",
  "puk2": "589756",
  "pin1": "1234",
  "pin2": "4321",
  "formFactor": "NANO",
  "network": "TELENOR",
  "inStorageAt": "650000000000000000000101",
  "autoAssign": true,
  "tag": "poolA"
}

Errors

Error code	Message	Description
422	id	SIM id is invalid
404	not_found	SIM not found
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents

API : SIM Get

Introduction

Request

Query example

Response

Example - normal

Errors