XIQS Gsm Port List

getXIQSGsmPortList ( [ Long id_partition ] , [ filter f ] )

Get a list of GSM port objects visible by this user's partition. In the case the current logged user is administrator, he gets the full list of all available GSM port objects unless a 'partition id' parameter is specified.

[Long id_partition]

Partition Id

[ filter f ]

Optional: a filter object

List of <port> object

Long id - GSM Port Id

Long id_card - SIM Id

Integer portnum - Port Number

Integer status - Port Status. Indicate the current status of a given GSM port

Possible values:

0 - INITIALIZING

1 - INITIALIZED

2 - Registered but Reject all outgoing calls Used by Transaction or Error Management

3 - REGISTERED

4 - SIM_MISSING

5 - SIM_PIN_FAIL

6 - SIM_PUK

7 - SIM_NOT_READY

8 - SIM_NEW_DETECTED

9 - NOT_REGISTERED

10 - MAX_BOARD_INIT

11 - ERR_COMMAND

12 - TIMEOUT

13 - NOT_INITIALIZED

14 - FIRM_UPDATING

15 - FIRM_UPDATED

16 - FIRM_UPDATE_FAIL

17 - SIM_PIN_WAITING

18 - SIM_PIN_FAIL_WAITING

19 - SERVICE_STOPPED

20 - ERR_SYSTEM_RESOURCES

21 - PORT_CLOSED

22 - MODULE_DEAD

23 - SIM_ENUMERATING

24 - SIM_NO_TRAY

25 - SIM_ARRAY_DISCONNECTED

26 - ERR_SIM_NO_SIM

27 - SIM_LOCKED

404 - Not present

500 - Disabled

503 - Port not configured for sim manager

504 - Not present, disabled

String imei - The International Mobile Equipment Identifier (IMEI) of the given GSM port

Long id_arule - The Id of the rule used for allocating the current SIM card to the given GSM port

Long enddate - The date until which this SIM can be used (in seconds since 01/01/1970)

Integer assignfailure - Number of consecutive SIM assignations failures on the port

Long callduration - Call duration

Long missedcallnb - Number of missed calls

Long lastreset - The date and time setting of the last port reset (in seconds since 01/01/1970)

Integer mode - Port mode (0 - Static SIM without SIM Server mode, 1 - Usable by SIM Server, 3 - Statis SIM in SIM Server mode)

Long callleasetime - Call time left before SIM deallocation

Long callsleftnb - Number of calls before SIM deallocation

String imsi - The International Mobile Subscriber Identifier (IMSI) of the given GSM port

String iccid - The Integrated Circuit Card ID (ICCID) of the SIM card currently allocated to the given GSM port

String prev_imsi - Previous IMSI

String prev_iccid - Previous ICCID

String id_partition - Partition Id

String devicename - Device Name

String deviceregsn - Device registration S/N

Integer devicestatus - Device status(0 - device unreachable, 1 - device ready)t

String version -

String portimei - Default port imei for local (physical) sims

Long plmn -

Long lac -

Long id_cell -

Long bcch -

Long rxlevel -

Long isusrsel - Does current GSM cell is user choice

Long id_usrsel - User selected GSM cell (0 in auto mode)

Long usrselplmn - User selected GSM cell PLMN

Long usrsellac - User selected GSM cell LAC

Long usrselbcch - User selected GSM cell BCCH

Integer usrselstatus - User selected GSM cell status:
0 - Auto mode
1 - Cell used is not user selected one
2 - Cell used is user selected one

Integer hwmodel - GSM Port Hardware model id:
(-1) - Hardware Unknown
0 - Siemens GSM TC35
1 - Siemens GSM TC35I
2 - Siemens GSM MC39I
3 - Siemens GSM PCS MC55
4 - Siemens GSM PCS MC56
5 - Sierra Wireless UMTS MC8755
6 - Sierra Wireless UMTS MC8765
7 - Sierra Wireless CDMA MC5725
8 - Telit UMTS UC864E Europe
9 - Telit UMTS UC864G World
10 - Telit GSM GC864 Quad Band
11 - Siemens GSM MC55i Quad Band
12 - Sierra Wireless GSM WMP100 (Q55)
13 - Telit GSM GC864 v2 Quad Band
14 - Sierra Wireless GSM Quad Band SL6087
15 - Sierra Wireless UMTS SL8082t
16 - Sierra Wireless LTE MC7710

Error Data structure ( Error Management )

Possible failure code returns

• ERR_SRV_INTERNAL (500) ERR_MSG_NO_DB