listWWanConnection.lua
[INDEX]

ABSTRACT

List all saved(remembered) WWan connections

ARGUMENTS

HTTP Arguments submit: GET; POST

Test this API over HTTP - (URL):

DeviceObject

Optional.if specified, then it is ObjectID of network interface (Refer to getNetInterface.lua); otherwise, it is the default WWan interface.

Test value:

RETURNS

Return a JSON style result. The JSON format is:

{
/*OBJECT*/

"Result":
NUMBER

200 means OK, other error code meanings are similar to HTTP Response.

"Status":
"STRING"

Status message. Responsing result status of API executive, if there errors, it will describe reasons.

"Data": {
/*OBJECT*/

"Device":
"STRING"

WWan device name(e.g. ppp0)

"Object":
"STRING"

WWan object name

"CONNECTION_list": [
/*ARRAY*/

Each one is a saved(remembered) connection, content as followings:

{
/*OBJECT*/

"Title":
"STRING"

Connection title

"Type":
"STRING"

Connection type:

gsm

For GSM/HSPA/LTE

cdma

For CDMA

other

Others

"IsCurrent":
"STRING"

0|1, Whether the connection is currently in use

"AddressResolve":
"STRING"

IP addresses resolve:

dhcp

DHCP [For WWan, technically, is DHCP]

manual

Manually

"Object":
"STRING"

Connection object name:

Pay attention of this Object, you must provide it for changing/connecting/disconnecting/deleting connection. The object name is like: /org/freedesktop/NetworkManager/Connections/3

"Uuid":
"STRING"

The UUID of this connection. You must provide it for changing connection.

"GSM_APN":
"STRING"

if the type is gsm, this is the APN

"GSM_Number":
"STRING"

if the type is gsm, this is the dial number

"GSM_User":
"STRING"

if the type is gsm, this is the username

"GSM_Password":
"STRING"

if the type is gsm, this is the password

"GSM_Pin":
"STRING"

if the type is gsm, this is the SIM PIN

"CDMA_Number":
"STRING"

if the type is cdma, this is dial number

"CDMA_User":
"STRING"

if the type is cdma, this is the username

"CDMA_Password":
"STRING"

if the type is cdma, this is the password

}
]
}
}

OTHER NOTES

Device HTTP API, v1.0