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, MANAGER or OWNER if user belongs to the customer who has the SIM in storage. RESELLER if customer belongs to the reseller. ADMIN.
Param	SIM_ID	SIM card number (ICC)

Query example

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

Response

JSON object
_id	String	SIM card number (ICC).
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 or eSIM.
network	String	The network the SIM card is for: TELENOR, TDC or TELIA
inStorageAt	Id	Id of the customer or reseller where the SIM card is in storage at. Null if Held by Telecom X.
autoAssign	Boolean	If a SIM-card is an “auto-assign” SIM, it means that 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 have a storage of SIM cards.

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

Example - normal

{
  _id: '1234567890123456789',
  puk1: '587896',
  puk2: '589756',
  pin1: '1234',
  pin2: '4321',
  formFactor: 'NANO',
  network: 'TELENOR',
  inStorageAt: '1234567890ABCDEF12345678',
  autoAssign: true
}

Errors

Error code	Message	Description
400	bad_request	SIM number not found in request URI
404	not_found	SIM not found
403	access_denied	Insufficient access level

WIKI

Table of Contents

API : SIM Get

Introduction

Request

Query example

Response

Example - normal

Errors