XIQS Create Device Plan

From IQsimWiki

(Difference between revisions)
Jump to: navigation, search
 
Line 3: Line 3:
  ! 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 plan
  Create a new device plan
|}
|}
Line 11: Line 11:
  |-         
  |-         
  |
  |
-
''string'' '''device plan name'''   
+
''string'' '''device_plan_name'''   
  Must be unique on the partition.  
  Must be unique on the partition.  
-
''long'' '''country group restricted'''  
+
''long'' '''country_group_restricted'''  
  Country Group Id  
  Country Group Id  
-
''long'' '''timing type'''
+
''long'' '''timing_type'''
  0: Number of days<br>
  0: Number of days<br>
  1: Monthly
  1: Monthly
-
''long'' '''timing day'''
+
''long'' '''timing_day'''
  Number of days or Birthday according to timingtype  
  Number of days or Birthday according to timingtype  
-
''long'' '''end of pass'''  
+
''long'' '''end_of_pass'''  
  0: Partition Midnight<br>
  0: Partition Midnight<br>
  1: Device Local Midnight  
  1: Device Local Midnight  
-
''long'' '''data flags'''
+
''long'' '''data_flags'''
  1: Data unlimited<br>
  1: Data unlimited<br>
  2: Low Speed Data unlimited  
  2: Low Speed Data unlimited  
-
''long'' '''high speed volume''''''  
+
''long'' '''high_speed_volume''''''  
  Data (Kilo Bytes)  
  Data (Kilo Bytes)  
-
''long'' '''low speed volume'''  
+
''long'' '''low_speed_volume'''  
  Low Speed Data (Kilo Bytes)  
  Low Speed Data (Kilo Bytes)  
-
''long'' '''low speed bandwidth'''  
+
''long'' '''low_speed_bandwidth'''  
  Low Speed Bandwidth (Kilo Bit per second)  
  Low Speed Bandwidth (Kilo Bit per second)  
-
''long'' '''extra group id'''  
+
''long'' '''extra_group_id'''  
  Country Group Id  
  Country Group Id  
-
''long'' '''extra group volume'''  
+
''long'' '''extra_group_volume'''  
  Supplementary Data (Kilo Bytes)  
  Supplementary Data (Kilo Bytes)  
-
''long'' '''billing type'''  
+
''long'' '''billing_type'''  
  Always 0 (reserved for future use)  
  Always 0 (reserved for future use)  
-
[ ''long'' '''partition id''' ]  
+
[ ''long'' '''partition_id''' ]  
  Partition id (Mandatory for administrator)
  Partition id (Mandatory for administrator)
|}
|}

Latest revision as of 07:49, 9 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 plan
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