Suntel:SAAS Soap API
From Suntel Communications knowledgebase
Introduction
In SAAAS everything is based on unique APN names. These are string names as used in a GPRS Terminal device and not the numeric APN definition as in HLR.
Apn create, list and delete are system wide funtions. All other functions are APN specific. Since everything is based on APN name, all other definitions (Pool Names, MSISDN definitions, Paswords, IP and pool associations) are all in the scope of a given APN and do not conflict with another APN's corresponding definitions.
This means that those names have to be unique within a single APN context but can be freely used within other APN's with a different context and meaning.
An APN can use either Static or Dynamic IP Assignment from an IP Pool or any combination of static and dynamic methods.
If both Static and Dynamic IP assignment is used within the same APN then static IP's must not be within the range of a Dynamic Pool defined for that APN.
There may be more than one Dynamic Pool per APN, with the restriction that the IP ranges of the pools don't overlap each other.
A static IP may be assigned to more than one MSISDN however only one of those may be connected to the network simultaneously.
A MSISDN can at most have one association. Any new assignment will free the previous association for that MSISDN.
Please note that changes do not affect currently connected devices until they disconnect and reconnect to the network.
CreateApn
Usage:
- Soap Message CreateApn(str ApnName)
Description:
- Creates the APN with ApnName. ApnName must be unique. If it is already used, function fails with error code DUPLICATE_APN_NAME.
Return Values
- Int StatusCode (0 No Error)
ListApn
Usage:
- Soap Message ListApn()
Description:
- Lists all APN names in the system
Return Values
- Int StatusCode (0 No Error)
- str ApnLists (seperated ";")
DeleteApn
Usage:
- Soap Message DeleteApn(str ApnName)
Description:
- Deletes an APN from the system. All Pool and MSISDN definitions of the APN is deleted as well.
Return Values
- Int StatusCode (0 No Error)
AddMSISDN
Usage:
- Soap Message AddMSISDN(str ApnName, str MSISDN, str Password)
Description:
- Add an Phone with MSISDN to APN ApnName with password Password. An MSISDN can be added to multiple APN's, however not multiple times to the same APN.
Return Values
- Int StatusCode (0 No Error)
ChangePassword
Usage:
- Soap Message ChangePassword(str ApnName, str MSISDN, str NewPassword)
Description:
- Change the password of an existing Phone with MSISDN to NewPassword for APN ApnName.
Return Values
- Int StatusCode (0 No Error)
DeleteMSISDN
Usage:
- Soap Message DeleteMSISDN(str ApnName, str MSISDN)
Description:
- Deletes the MSISDN definition for ApnName. Password, Pool and Static IP assignment settings for the MSISN are also freed.
Return Values
- Int StatusCode (0 No Error)
CreateIpPool
Usage:
- Soap Message CreateIpPool(str ApnName, str PoolName, str/inet4 PoolBeginAddr, str/inet4 PoolEndAddr)
Description:
- Creates and defines an IP Pool for APN ApnName. PoolEndAddr must be greater then PoolBeginAddr. The Pool range does not have to be a subnet. The pool can be smaller then the number of MSISDN's assigned to it, however simultaneous users will be limited with the number of IP's in the Range.An Pool name can be used with multiple APN's, however not multiple times to the same APN.
Return Values
- Int StatusCode (0 No Error)
GetIpPoolNames
Usage:
- Soap Message GetIpPoolNames(str ApnName)
Description:
- Returns the list of defined IP Pool Names for the given APN ApnName.
Return Values
- Int StatusCode (0 No Error)
- str PoolNames (seperated ";")
GetIpPoolRange
Usage:
- Soap Message GetIpPoolRange(str ApnName, str PoolName)
Description:
- Returns the IP Pool Range for IP Pool PoolName of the APN ApnName.
Return Values
- Int StatusCode (0 No Error)
- str/inet4 PoolBeginAddr
- str/inet4 PoolEndAddr
ChangeIpPoolRange
Usage:
- Soap Message ChangeIpPoolRange(str ApnName, str PoolName, str/inet4 PoolBeginAddr, str/inet4 PoolEndAddr)
Description:
- Changed the IP Range of an existing Pool. Please note that open connections using the old range will NOT be disconnected. They will get their IP lease from the new range on their next connection.
Return Values
- Int StatusCode (0 No Error)
DeleteIpPool
Usage:
- Soap Message DeleteIpPool(str ApnName, str PoolName)
Description:
- Deletes the Pool definition and MSISDN associations. Aktive connections will not be dropped. MSISDN definitions and Passwords associated with the pool will not be deleted either. Hwever they have to be assigned to another pool or to static IP's to be able to connect to the system.
Return Values
- Int StatusCode (0 No Error)
AssignMSISDNToIpPool
Usage:
- Soap Message AssignMSISDNToIpPool(str ApnName, str PoolName, str MSISDN)
Description:
- Associated an MSISDN for the ApnName to IP Pool PoolName. Any previouse association will be freed. If MSISDN is connected the connection will not be dropped and new IP will be assigned on the next connect.
Return Values
- Int StatusCode (0 No Error)
GetIpPoolOfMSISDN
Usage:
- Soap Message GetIpPoolOfMSISDN(str ApnName, str MSISDN)
Description:
- Returns the name of IP Pool MSISDN is associated with.
Return Values
- Int StatusCode (0 No Error)
- str PoolName
GetMSISDNsOfIpPool
Usage:
- Soap Message GetMSISDNsOfIpPool(str ApnName, str PoolName)
Description:
- Returns the list of MSISDN's associated with the pool PoolName.
Return Values
- Int StatusCode (0 No Error)
- str MSISDN (seperated ";")
AssignStaticIpToMSISDN
Usage:
- Soap Message AssignStaticIpToMSISDN(str ApnName, str MSISDN, str/inet4 StaticIp)
Description:
- Associates an IP for MSISDN for static IP assignment. An IP can associated with multiple MSISDN's, however one of them can be connected to the system at a time. Any previous association for the MSISDN for the ApnName will be freed.
Return Values
- Int StatusCode (0 No Error)
GetStaticIpOfMSISDN
Usage:
- Soap Message GetStaticIpOfMSISDN(str ApnName, str MSISDN)
Description:
- Returns the static IP associated with MSISDN
Return Values
- Int StatusCode (0 No Error)
- str/inet4 StaticIp
GetMSISDNsOfStaticIp
Usage:
- Soap Message GetMSISDNsOfStaticIp(str ApnName, str/inet4 StaticIp)
Description:
- Returns the list of MSISDNs associated with static IP StaticIP.
Return Values
- Int StatusCode (0 No Error)
- str MSISDNsList (seperated ";")
FreeStaticIpOfMSISDN
Usage:
- Soap Message FreeStaticIpOfMSISDN(str ApnName, str MSISDN)
Description:
- Frees any association for the MSISDN for ApnName.
Return Values
- Int StatusCode (0 No Error)
