SIM Card Model

The SIM Card Model – is a base model for show platform SIM card parameters. Model fields are presented in the table (Table 4.9), with an example below (Listing 4.7). There are the following types of this model (Table 4.10).

Table 4.9 – Fields of SIM Card Model

№	Key	Type	Exists	Description
1	iccid	string	required	Identifier of SIM Card
2	sim_card_type	string	optional	Type of SIM, if it exists
3	msisdn	string	optional	Identifier of SIM line
4	imei	string	optional	Identifier of SIM device, if it exists
5	is_e_sim	boolean	optional	Shows whether it is an eSIM card
6	status	Status Model	optional	Current SIM Card status
7	plan	Plan Model	optional	SIM Plan, if it exists
8	company	Account Model	optional	Assigned SIM Company
9	end_user	Account Model	optional	Assigned SIM End User
10	details	array	optional	Details about SIM Card like usage, etc.

Listing 4.7 – Example of SIM Card Model (JSON)

{ 
    "iccid":            "8920000012345678900", 
    "sim_card_type":    "prepaid", 
    "msisdn":           "01234567890", 
    "imei":             "86-000000-111111-2", 
    "is_e_sim":         false, 
    "status":           {...//Status Model}, 
    "plan":             {...//Plan Model}, 
    "company":          {...//Account Model}, 
    "end_user":         {...//End User Model}, 
    "details":          ["current_usage_kb" => 512, ...] 
}

Table 4.10 – Sim Card Types

№	Title	Description
1	Prepaid	SIM Card with Prepaid Plan
2	Subscription	SIM Card with one of Subscription Plans
3	PAYGO	SIM Card with PAYGO Plan
4	Without Type	Blank SIM Card. May be unavailable