Get Subscriber SIM Settings
The Get Subscriber SIM Settings API is used to retrieve SIM related attribute settings.
| HTTP URL | |
|---|---|
| GET | api/v2/subscriber/{type}/{value}/sim |
NOTE: All {type} and {value} pairs, define the search criteria. Valid {type} ENUMs are: ‘imsi’, ‘iccid’, ‘msisdn’, ‘imei’.
Eligibility
The Requestor is eligible to request his own subscribers' SIM settings information regardless of their actual existence (which level they reside in).
API Request
Not applicable
API Response
Response Structure
| Parameter | Type | M/O/CM | Description |
|---|---|---|---|
| errorCode | String | O | Failure code. See list below, under ‘Error Codes’ section |
| errorMessage | String | O | Failure detailed description. See list below, under ‘Error Codes’ section |
| content | Object | O | Array of main response body object. Displayed when an API call was successful. For a failure it will be empty. |
| pageable | Object | O | Paging information object. Displayed when an API call was successful. For a failure it will be empty. |
Content Data Objects
| Parameter | Type | M/O/CM | Description |
|---|---|---|---|
| appletMode | String | M | Get the SIM applet mode. Determines whether the active IMSI can be set manually, or the applet determines which IMSI to use. ENUM valid values: MANUAL, AUTOMATIC |
| sim | Object | M | Array of SIMs object – In-Use IMSIs only will be retrieved |
SIM
| Parameter | Type | M/O/CM | Description |
|---|---|---|---|
| imsi | String | M | IMSI number registered on current SIM instance |
| slotNumber | Numeric | M | IMSI slot number. Card can have a maximum of 10 slots |
| preferredOperatorNetworks | String | O | Array of operator networks that get precedence on unlisted networks in the current SIM instance (given IMSI) while roaming. Networks are presented as MCCMNC values. Networks presented as comma separated MCCMNC values. Networks presented as comma separated MCCMNC values. |
| forbiddenNetworks | String | O | Array of networks that the current SIM instance (given IMSI) cannot connect to while roaming. Networks are presented as MCCMNC values. |
| allowedCountries | String | O |
Array of IMSI related Mobile Country Codes (MCC). The device is allowed to make a connection while in this country/continent. Comma separated values. Max 16 items in the array are allowed. The following values represent a whole mainland using a single item: 2FF,3FF,4FF,5FF,6FF,7FF
|
| isActive | Boolean | M | Indicates whether the SIM instance (IMSI) is active. Only one IMSI can be active at a time. True = Active IMSI, False = Inactive IMSI |
Pageable data objects
| Element | Type | M/O/CM | Description |
|---|---|---|---|
| page | Numeric | M | Page number |
| size | Numeric | M | Page size. Number of requested elements per page |
| totalPages | Numeric | M | Total amount of available pages per requested page size |
| totalElements | Numeric | M | Total amount of retrieved elements |
Error Codes
In addition to the general success and failure codes, the following error codes are possible.
| Code | Message |
|---|---|
| GLOBAL_1001 | Service unavailable. Please try again |
Examples
Response Body: Success ACK
{
"errorCode": "",
"errorMessage": "",
"content": [
{
"appletMode": "MANUAL",
"sim": [
{
"imsi": "222013090961859",
"slotNumber": "1",
"preferredOperatorNetworks": [
"302220",
"302500"
],
"forbiddenNetworks": [
"23430",
"23415",
"90146"
],
"allowedCountries": "001",
"isActive": true
},
{
"imsi": "310380501118337",
"slotNumber": "2",
"preferredOperatorNetworks": [],
"forbiddenNetworks": [],
"allowedCountries": "",
"isActive": false
}
]
}
],
"pageable": null
}
Response Body: Failure NAK
{
"errorCode": "GLOBAL_1001",
"errorMessage": "Service unavailable. Please try again",
"content": "",
"pageable": null
}