POST /api/plan/list
| Input Parameters | Required ? | Description |
|---|---|---|
| userid | Y | CRM Login User's numerical ID value. Not username |
| api_key | Y | api_key for the above Userid |
| ispid | N | ISP ID |
| resellerid | N | Reseller ID |
| planid | N | Plan ID |
| name | N | Plan Name. Partial text accepted |
| protocol | N | Protocol. Allowed values: PPPoE, IPoE, LeasedLine |
| connectivity | N | Connectivity. Allowed values: Wireless, Fibre, Hotspot |
| plan_period | N | Plan Period. Numerical value only. |
| plan_period_unit | N | Plan Period Unit. Allowed values: Day, Month, Year |
| location_code | N | Locatoin code |
| sub_location_code | N | Sub Locatoin code |
| enabled | N | Is Enabled? Allowed values: Y, N |
| data_carryover | N | Is Data Carry over? Allowed values: Y, N |
| hide_bw_limit | N | Is Bandwidth limit is disabled? Allowed values: Y, N |
| limit1_gb | N | Usage Limit (in GB) on BW Level 1. Accepted Comparison Operators, like: <50, ≤10, ≥80, =100, etc. |
| created_from | N | Created from date in yyyy-mm-dd format |
| created_upto | N | Created upto date in yyyy-mm-dd format |
| rows_limit | N | Limit the number of records in result set. Default: 10, Max value: 100 |
| rows_offset | N | Fetch records from this offset position. Default: 0 |
| sort_field | N | Sorts the result. Sort field should be any one of: id, name, protocol, connectivity, lc, slc, limit1_gb, bw1_dl, bw1_ul. Default: id |
| sort_order | N | Sort order. Allowed values are: asc, desc. Default: asc |
| show_count | N | Shows Records Count only, instead of detailed results. This will ignore rows_limit, rows_offset. Allowed values are: 0, 1. Default: 0 |
curl -X POST $BASE_URL/api/plan/list -d userid=5 -d api_key="0f9895fb407c83e5ea128082098b47681aa75d6944576423c4" -d plan_period=1 -d plan_period_unit="Month"
POST /api/plan/subplan_list
| Input Parameters | Required ? | Description |
|---|---|---|
| userid | Y | CRM Login User's numerical ID value. Not username |
| api_key | Y | api_key for the above Userid |
| ispid | N | ISP ID |
| resellerid | N | Reseller ID |
| planid | N | Plan ID |
| subplanid | N | Sub Plan ID |
| name | N | Sub Plan Name. Partial text accepted |
| portal | N | Publish to Web Portal? Allowed values: Y, N |
| price | N | Plan Price. Accepted Comparison Operators, like: <50, ≤10, ≥80, =100, etc. |
| created_from | N | Created from date in yyyy-mm-dd format |
| created_upto | N | Created upto date in yyyy-mm-dd format |
| rows_limit | N | Limit the number of records in result set. Default: 10, Max value: 100 |
| rows_offset | N | Fetch records from this offset position. Default: 0 |
| sort_field | N | Sorts the result. Sort field should be any one of: id, name, planid, units, price. Default: id |
| sort_order | N | Sort order. Allowed values are: asc, desc. Default: asc |
| show_count | N | Shows Records Count only, instead of detailed results. This will ignore rows_limit, rows_offset. Allowed values are: 0, 1. Default: 0 |
curl -X POST $BASE_URL/api/plan/subplan -d userid=5 -d api_key="0f9895fb407c83e5ea128082098b47681aa75d6944576423c4" -d planid=12 -d show_count=1
The typical API Response will be
{
"result": 3,
"error": null
}