Section X - Profiles details API

X1 - Get all profile Ids

GET Method :

/api/v1/get_all_profile_ids/< visable > with the following data:

Input :

Argument	Mandatory	Value
visable	No	Text < true, false>(default true)

Sample Output :

[
 {
 "Profile": {
 "id": "2",
 "name": "Guest profile",
"deactivated": 0
 }
 },
 {
 "Profile": {
 "id": "3",
 "name": "1mbps"
"deactivated": 1
 }
 }
]

X2 - Get profile details

GET Method :

/api/v1/get_profile_details/< profileId > with the following data:

Input :

Argument	Mandatory	Value
profileId	Yes	Numeric < Id of the profile>

Sample Output :

{
 "status": "success",
 "errorCode" = 200,
 "message": {
 "profile Details": [
 {
 "property": "Reset billing cycle",
 "value": "weekly"
 },
 {
 "property": "Day of the week to reset billing cycle",
 "value": "Sunday"
 },
 {
 "property": "Day of the week to reset billing cycle",
 "value": "Sunday"
 },
 {
 "property": "Account Expiry",
 "value": "30 minutes from first login"
 },
 {
 "property": "Bandwidth",
 "value": "1mbps template"
 },
 {
 "property": "Billing Type ",
 "value": "Enterprise Billing"
 }
 ],
 "billing Details": [
 {
 "property": "description",
 "value": "1mbps"
 },
 {
 "property": "period",
 "value": "1month(s)"
 },
 {
 "property": "description",
 "value": "servicetax"
 },
 {
 "property": "period",
 "value": "1month(s)"
 },
 {
 "property": "period",
 "value": "1month(s)"
 },
 {
 "property": "Total Price",
 "value": 1000
 }
 ],
"vendorData":[ { 
 "type":"reply",
 "vendor":"Mikrotik",
 "attribute":"Mikrotik-Address-List",
 "expression":":=",
 "value":"ParentalControl"
 }}}

X3 - Get bandwidth details

GET Method :

/api/v1/get_bandwidth_details

Sample Output :

[
 {
 "id": "8",
 "name": "1 Mbps",
 "MaxDownload": "1 Mbps",
 "MaxUpload": "1 Mbps",
 "MinDownload": "1024 Kbps",
 "MinUpload": "1024 Kbps",
 "burstRate": "0/0 Bytes",
 "burstThreshold": "0/0 Bytes",
 "burstTime": "0/0",
 "priority": "0"
 },
 {
   "id": "9",
   "name": "2 Mbps",
   "MaxDownload": "2 Mbps",
   "MaxUpload": "2 Mbps",
   "MinDownload": "2048 Kbps",
   "MinUpload": "2048 Kbps",
   "burstRate": "0/0 Bytes",
   "burstThreshold": "0/0 Bytes",
 "burstTime": "0/0",
 "priority": "0"
 } ]

X4 - Get override profile details

GET Method :

/api/v1/get_override_profile_details/< userId > with the following data:

Input :

Argument	Mandatory	Value
profileId	Yes	Numeric < Id of the user>

Sample Output :

{ 
 "status":"success",
 "errorCode":200,
 "message":{ 
 "profile Details":[ 
 { 
 "property":"Reset billing cycle",
 "value":"monthly"
 },
 { 
 "property":"Day of the month to reset billing cycle",
 "value":"1"
 },
 { 
 "property":"Notify user",
 "value":"41,43,46% of bandwidth restriction via email sms "
 },
 { 
 "property":"Simultaneous Devices",
 "value":"5"
 },
 { 
 "property":"Bandwidth Level 1",
 "value":"2 Mbps template"
 },
 { 
 "property":"Bandwidth limit applies after",
 "value":"10 GB"
 },
 { 
 "property":"Duration counter reset bandwidth cycle",
 "value":"billing_cycle"
 },
 { 
 "property":"Bandwidth Level 2",
 "value":"1 Mbps template"
 },
 { 
 "property":"Idle Timeout",
 "value":"3 minute(s)"
 },
 { 
 "property":"Auto bind MAC to user on first login",
 "value":"on"
 },
 { 
 "property":"Number Of MAC'S to bind",
 "value":"10"
 },
 { 
 "property":"MAC restriction",
 "value":"enabled"
 },
 { 
 "property":"IP restriction",
 "value":"enabled"
 },
 { 
 "property":"Hard Timeout",
 "value":"6 minute(s)"
 },
 {
    "property":"Vendor attributes 2nd set applies after",
 "value":"11 MB"
 },
 { 
 "property":"Vendor attributes Data counter reset period",
 "value":"daily"
 },
 { 
 "property":"Vendor Attributes",
 "value":"true"
 }
 ],
 "vendorData":[ 
 { 
 "type":"reply",
 "vendor":"Mikrotik",
 "attribute":"Mikrotik-Address-List",
 "expression":":=",
 "value":"ParentalControl"
 }
 ],
 "vendorData1":[ 
 {"type":"reply",
 "vendor":"Mikrotik",
 "attribute":"Mikrotik-Address-List",
 "expression":":=",
 "value":"ParentalControl"
 }
 ]
 } }