API for browsing, adding, editing and deleting Mobile SIMs.
GET /mobilesims
Return a list of Mobile SIMs.
Supports $format= option.
GET /mobilesims/{MobileSimId}
Return a specific Mobile SIM by Id.
GET /mobilesims?iccid={iccid}
Return a specific Mobile SIM by ICCID.
POST /mobilesims
Create a new Mobile SIM.
PUT /mobilesims/{MobileSimId}
Update an existing Mobile SIM.
DELETE /mobilesims/{MobileSimId}
Delete the specified Mobile SIM.
GET /Accounts/Services/MobileSims/Assign/Find/{FindText}'
Find unassigned SIMs matching any part of the IMSI or MSISDN specified in {FindText}.
For example, FindText=1234 will match 5551234, 1234555 and 55512346789.
Supports $format= option.
GET /Accounts/Services/MobileSims/Assign/Lookup
List SIMs that are available for assignment to any account.
GET /Accounts/{AccountId}/Services/MobileSims
List SIMs assigned to a specific account {AccountId}.
PUT /Accounts/{AccountId}/Services/MobileSims/{MobileSimId}/Assign
Assign SIM {MobileSimId} to account {AccountId}.
PUT /Accounts/{AccountId}/Services/MobileSims/{MobileSimId}/Move
Re-assign SIM {MobileSimId} from another account to {AccountId}.
PUT /Accounts/Services/MobileSims/{MobileSimId}/Terminate
Terminate SIM {MobileSimId}.
PUT Accounts/Services/MobileSims/{MobileSimId}/Unassign
Un-assign SIM {MobileSimId} from to account to which it is currently assigned.
Looking up a Resource (single objects, lists and tabular data)
Creating a Resource
Updating a Resource
Deleting a Resource
Mobile SIM Profiles API
Accounts API
{
"MobileSimId": 0,
"Iccid": "",
"Pin1": "",
"Puk1": "",
"Pin2": "",
"Puk2": "",
"Enabled": false,
"SimStatusType": "sstNone",
"ActiveProfileId": 0,
"ActiveProfileName": "",
"DefaultProfileId": 0,
"DefaultProfileName": "",
"TerminatedDateTime": "",
"NotificationSimRegistration": false,
"NotificationNetworkRegistration": false,
"NotificationBalanceCall": false,
"NotificationBalanceSms": false,
"NotificationBalanceMms": false,
"NotificationBalanceData": false,
"NotificationTopUp": false,
"NotificationLowBalance": false,
"NotificationVoicemail": false,
"MultiImsiVersion": "",
"ZonaCasaVersion": "",
"AccountId": 0,
"Account": "",
"AccountGroupId": 0,
"AccountGroup": "",
"Description": "",
"StartDateTime": "",
"EndDateTime": "",
"Notes": "",
"LastUpdatedDateTime": "",
"LastUpdatedBy": ""
}
This table stores the mobile SIMs in the system.
| Field Name | Type | Size | Description |
|---|---|---|---|
| MOBILE_SIM_ID | bigint | 8 | Primary key. |
| ICCID | varchar | 20 | The ICCID of the SIM. |
| PIN1 | varchar | 8 | The PIN1 of the SIM. |
| PUK1 | varchar | 10 | The PUK1 of the SIM used to unlock the PIN1. |
| PIN2 | smallint | 2 | The PIN2 of the SIM. |
| PUK2 | varchar | 20 | The PUK2 of the SIM used to unlock the PIN2. |
| ENABLED | bit | 1 | Specifies whether or not this mobile SIM profile can be used by the system. 0 – Disabled 1 – Enabled |
| SIM_STATUS_TYPE | tinyint | 1 | Foreign key into the SIM_STATUS_TYPES table. |
| ACTIVE_PROFILE_ID | smallint | 2 | Foreign key into the MOBILE_SIM_PROFILES table used to identify the active profile on the SIM. This initial value is zero (0). Upon authentication, it will be set to the MobileSimProfileId of the profile associated with the MSISDN. The ActiveProfileId will be updated whenever a different profile is used for authentication (i.e., the MobileSimProfileId of the authenticated MSISDN is different from the one currently assigned to this field). |
| DEFAULT_PROFILE_ID | smallint | 2 | Foreign key into the MOBILE_SIM_PROFILES table used to identify the default profile on the SIM. |
| TERMINATED_DATE_TIME | smalldatetime | 4 | The date and time the SIM was terminated. |
| NOTIFICATION_SIM_REGISTRATION | bit | 1 | Whether or not the subscriber receives a notification for SIM registration. |
| NOTIFICATION_NETWORK_REGISTRATION | bit | 1 | Whether or not the subscriber receives a notification for network registration. |
| NOTIFICATION_BALANCE_CALL | bit | 1 | Whether or not the subscriber receives a balance notification at the end of a call. |
| NOTIFICATION_BALANCE_SMS | bit | 1 | Whether or not the subscriber receives a balance notification at the end of an SMS message. |
| NOTIFICATION_BALANCE_MMS | bit | 1 | Whether or not the subscriber receives a balance notification at the end of an MMS message. |
| NOTIFICATION_BALANCE_DATA | bit | 1 | Whether or not the subscriber receives a balance notification at the end of a data session. |
| NOTIFICATION_TOP_UP | bit | 1 | Whether or not the subscriber receives a top up notification when the MOBILE_LOW_BALANCE = threshold is reached. |
| NOTIFICATION_LOW_BALANCE | bit | 1 | Whether or not the subscriber receives a balance notification when the MOBILE_LOW_BALANCE = threshold is reached. |
| NOTIFICATION_VOICEMAIL | bit | 1 | Whether or not the subscriber receives a notification when a voicemail is left. |
| START_DATE_TIME | smalldatetime | 4 | The date and time after which the SIM is active. |
| END_DATE_TIME | smalldatetime | 4 | The date and time before which the SIM is active. |
| MULTI_IMSI_VERSION | varchar | 10 | The version number of the multi IMSI SIM. |
| ZONA_CASA_VERSION | varchar | 10 | The Zona Casa application version on the SIM. |
| ACCOUNT_ID | bigint | 8 | Foreign key into the ACCOUNTS table used to identify the account that is assigned to this SIM. |
| ACCOUNT_GROUP_ID | smallint | 2 | Foreign key into the ACCOUNT_GROUPS table used to used to partition the pool of available SIMs in the system to a particular group accounts. |
| DESCRIPTION | varchar | 40 | The description of this entry. |
| NOTES | varchar | 1024 | Notes for this entry. |
| LAST_UPDATED_DATE_TIME | smalldatetime | 4 | Date and time in UTC this entry was last updated. |
| LAST_UPDATED_BY | varchar | 20 | The name of the user that last updated this record. |