API : Service

Service Management API

Get Status wise service count

POST /api/service/status_count

Typical API Call

curl -X POST $BASE_URL/api/service/status_count -d userid=5 -d api_key="0f9895fb407c83e5ea128082098b47681aa75d6944576423c4"

{
    "result": {
        "Active": 90,
        "Suspend": 125,
        "NP": 0,
        "NPD": 26,
        "Online": 13,
        "Total": 241
    },
    "error": null
}

Note: Online service count means that the total count of successfully authenticated services, which includes Active, Suspend, NP and NPD status services.

Get Service list

POST /api/service/list

Typical API Call

curl -X POST $BASE_URL/api/service/list -d userid=5 -d api_key="0f9895fb407c83e5ea128082098b47681aa75d6944576423c4" -d resellerid=1 -d os_amt=">=1000"

Create Service

POST /api/service/create

Typical API Call

curl -X POST $BASE_URL/api/service/create -d userid=5 -d api_key="0f9895fb407c83e5ea128082098b47681aa75d6944576423c4" -d customerid=1450 -d planid=69 -d subplanid=157 -d username="user1234" -d password="password" -d protocol="PPPoE" -d connectivity="Fibre" -d prepaid_postpaid="Postpaid" -d location_code="LOC1" -d sub_location_code="SLC1" -d installation_address="same" -d billing_address="same"

The expected API Response will be

{
    "result": 1559,
    "error": null
}

Returns newly created Service id value, upon success. Upon failure result contains null value, and error contains error description.

Update Service

POST /api/service/update

Typical API Call

curl -X POST $BASE_URL/api/service/update -d userid=5 -d api_key="0f9895fb407c83e5ea128082098b47681aa75d6944576423c4" -d serviceid=1559 -d mac_bind="Manual" -d mac="65:ec:ac:76:60:0e"

The expected API Response will be

{
    "result": "done",
    "error": null
}

Delete Service

POST /api/service/delete

Typical API Call

curl -X POST $BASE_URL/api/service/delete -d userid=5 -d api_key="0f9895fb407c83e5ea128082098b47681aa75d6944576423c4" -d serviceid=1559

The expected API Response will be

{
    "result": "done",
    "error": null
}

MAC Unbind

POST /api/service/mac_unbind

Typical API Call

curl -X POST $BASE_URL/api/service/mac_unbind -d userid=5 -d api_key="0f9895fb407c83e5ea128082098b47681aa75d6944576423c4" -d serviceid=1551

The expected API Response will be

{
    "result": "done",
    "error": null
}

Plan Change

POST /api/service/planchange

Typical API Call

curl -X POST $BASE_URL/api/service/planchange -d userid=5 -d api_key="0f9895fb407c83e5ea128082098b47681aa75d6944576423c4" -d serviceid=1551 -d planid=25 -d subplanid=117 -d schedule="next_bill"

The expected API Response will be

{
    "result": "done",
    "error": null
}

Topup

POST /api/service/topup

Typical API Call

curl -X POST $BASE_URL/api/service/topup -d userid=5 -d api_key="0f9895fb407c83e5ea128082098b47681aa75d6944576423c4" -d serviceid=1551 -d gb=10 -d amt=500 -d type="Expiring"

The expected API Response will be

{
    "result": "done",
    "error": null
}

Other actions

POST /api/service/action

Typical API Call

curl -X POST $BASE_URL/api/service/action -d userid=5 -d api_key="0f9895fb407c83e5ea128082098b47681aa75d6944576423c4" -d serviceid=1551 -d action="suspend"

The expected API Response will be

{
    "result": "done",
    "error": null
}

Usage Report

POST /api/service/usage_report

* Date range can be max 100 days for report_format=detailed & source=recent. And max date range can be 1100 days for other reports.

Typical API Call

curl $BASE_URL/api/service/usage_report -d userid=10 -d api_key="2107b12bfabd8af926da0e048d0e74e742a6c49dd94ff5ff2c" -d serviceid=1019 -d date_from="2020-10-01" -d date_upto="2020-10-02" -d source="archive" -d report_format="detailed"

The expected API Response will be

{
    "result": [
        {
            "ispid":"1", "resellerid":"1", "radacctid":"216806", "acctsessionid":"81801228", 
            "acctuniqueid":"40d327e999ac01f7ae0e43eba758c4d7", "username":"lena999",
            "realm":"", "nasipaddress":"172.20.20.1", "nasportid":"ether3",
            "nasporttype":"Ethernet", "acctstarttime":"2020-10-01 00:20:14", 
            "acctupdatetime":"2020-10-01 09:40:14", "acctstoptime":"2020-10-01 09:46:41",
            "acctinterval":"599", "acctsessiontime":"33986", "acctauthentic":"RADIUS",
            "connectinfo_start":"", "connectinfo_stop":"", "acctinputoctets":"36421923",
            "acctoutputoctets":"951885494", "calledstationid":"pppoe3",
            "callingstationid":"F4:6E:93:4C:6E:FD", "acctterminatecause":"User-Request",
            "servicetype":"Framed-User", "framedprotocol":"PPP", "framedipaddress":"10.1.1.251"
        },
        ....
    ],
    "error": null
}

another example

curl $BASE_URL/api/service/usage_report -d userid=10 -d api_key="2107b12bfabd8af926da0e048d0e74e742a6c49dd94ff5ff2c" -d serviceid=1019 -d date_from="2020-10-01" -d date_upto="2020-10-31" -d source="archive" -d report_format="day_wise_summary"

The expected API Response will be

{
    "result": [
        {
            "report_period":"2020-10-01", 
            "onlinetime":33986,
            "ul":36421923,
            "dl":951885494
        },
        {
            "report_period":"2020-10-02",
            "onlinetime":120574,
            "ul":1070843782,
            "dl":6020084273
        },
        {
            "report_period":"2020-10-03",
            "onlinetime":86000,
            "ul":501631126,
            "dl":6336925425
        },
        ....
    ],
    "error": null
}