XIQS Create Device Plan

From IQsimWiki

(Difference between revisions)
Jump to: navigation, search
(Created page with "'''XIQS Create Device Plan - Device Plan''' {| class="wikitable collapsible" style="width: 100%;background-color:#EFEEFE;" border="1" ! Description |- | '''createXIQSDevicePlan'...")
Line 1: Line 1:
'''XIQS Create Device Plan - Device Plan'''
'''XIQS Create Device Plan - Device Plan'''
{| class="wikitable collapsible" style="width: 100%;background-color:#EFEEFE;" border="1"
{| class="wikitable collapsible" style="width: 100%;background-color:#EFEEFE;" border="1"
-
! Description
+
! Description
-
|-  
+
|-  
-
| '''createXIQSDevicePlan''' ( ''string'' '''device plan name''', ''long'' '''country group restricted''' , ''long'' '''timing type''' , ''long'' '''timing day''',''long'' '''end of pass''', ''long'' '''data flags''', ''long'' '''high speed volume''',  ''long'' '''low speed volume''', ''long'' '''low speed bandwidth''',''long'' '''extra group id''',  ''long'' '''extra group volume''', ''long'' '''billing type''',  [ , ''long'' '''partition id''' ] )
+
| '''createXIQSDevicePlan''' ( ''string'' '''device plan name''', ''long'' '''country group restricted''' , ''long'' '''timing type''' , ''long'' '''timing day''',''long'' '''end of pass''', ''long'' '''data flags''', ''long'' '''high speed volume''',  ''long'' '''low speed volume''', ''long'' '''low speed bandwidth''',''long'' '''extra group id''',  ''long'' '''extra group volume''', ''long'' '''billing type''',  [ , ''long'' '''partition id''' ] )
  Create a new device plane
  Create a new device plane
 +
|}
 +
 +
{| class="wikitable collapsible" style="width: 100%;background-color:#EFEEFE;" border="1"
 +
! Parameters       
 +
|-       
 +
|
 +
''string'' '''device plan name''' 
 +
Must be unique on the partition.
 +
 +
''long'' '''country group restricted'''
 +
Country Group Id
 +
 +
''long'' '''timing type'''
 +
0: Number of days<br>
 +
1: Monthly
 +
 +
''long'' '''timing day'''
 +
Number of days or Birthday according to timingtype
 +
 +
''long'' '''end of pass'''
 +
0: Partition Midnight<br>
 +
1: Device Local Midnight
 +
 +
''long'' '''data flags'''
 +
1: Data unlimited<br>
 +
2: Low Speed Data unlimited
 +
 +
''long'' '''high speed volume''''''
 +
Data (Kilo Bytes)
 +
 +
''long'' '''low speed volume'''
 +
Low Speed Data (Kilo Bytes)
 +
 +
''long'' '''low speed bandwidth'''
 +
Low Speed Bandwidth (Kilo Bit per second)
 +
 +
''long'' '''extra group id'''
 +
Country Group Id
 +
 +
''long'' '''extra group volume'''
 +
Supplementary Data (Kilo Bytes)
 +
 +
''long'' '''billing type'''
 +
Always 0 (reserved for future use)
 +
 +
[ ''long'' '''partition id''' ]
 +
Partition id (Mandatory for administrator)
 +
|}
 +
 +
{| class="wikitable collapsible" cellpadding="5" cellspacing="5" style="width: 100%;background-color:#EFEEFE;" border="1"     
 +
! Return Values       
 +
|-       
 +
| ''Long'' '''id''' - Device Plan Id 
 +
Error Data structure ( [[Error Codes|Error Management]] )
 +
Possible failure code returns<br>
 +
*ERR_OBJECT_EXISTS(451) [[XIQS ERROR MESSAGES|ERR_MSG_DVC_FOUND]]<br>
 +
*ERR_SRV_INTERNAL (500) [[XIQS ERROR MESSAGES|ERR_MSG_NO_DB]] or [[XIQS ERROR MESSAGES|ERR_MSG_OBJ_NO_ID]]<br>
|}
|}

Revision as of 08:37, 8 July 2020

XIQS Create Device Plan - Device Plan

Description
createXIQSDevicePlan ( string device plan name, long country group restricted , long timing type , long timing day,long end of pass, long data flags, long high speed volume, long low speed volume, long low speed bandwidth,long extra group id, long extra group volume, long billing type, [ , long partition id ] ) 
Create a new device plane
Parameters

string device plan name 

Must be unique on the partition.

long country group restricted 

Country Group Id

long timing type 

0: Number of days

1: Monthly

long timing day 

Number of days or Birthday according to timingtype

long end of pass 

0: Partition Midnight

1: Device Local Midnight

long data flags 

1: Data unlimited

2: Low Speed Data unlimited

long high speed volume' 

Data (Kilo Bytes)

long low speed volume 

Low Speed Data (Kilo Bytes)

long low speed bandwidth 

Low Speed Bandwidth (Kilo Bit per second)

long extra group id 

Country Group Id

long extra group volume 

Supplementary Data (Kilo Bytes)

long billing type 

Always 0 (reserved for future use)

[ long partition id ] 

Partition id (Mandatory for administrator)
Return Values
Long id - Device Plan Id

Error Data structure ( Error Management ) 

Possible failure code returns
 
*ERR_OBJECT_EXISTS(451) ERR_MSG_DVC_FOUND

*ERR_SRV_INTERNAL (500) ERR_MSG_NO_DB or ERR_MSG_OBJ_NO_ID
Retrieved from "http://vpn.iqsim.com:8080/iqSimWiki/index.php?title=XIQS_Create_Device_Plan"
Personal tools
Namespaces
Variants
Views
Actions
Navigation
XIQS XML Protocol
XIQS Framework Libraries
XIQS Command List