API : Location

Location API


Get Location list

POST /api/location/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
lc N Location Code
location N Location Name. Wildcard search is available. You can use % in search query.

Typical API Call

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


Location create

POST /api/location/create

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
lc Y New Location Code
location Y New Location Name

Location Update

POST /api/location/update

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
lc Y Location Code to get updated
new_lc N New Location Code
new_location N New Location Name

Location Delete

POST /api/location/delete

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
lc Y Location Code to get deleted



Sub Location List

POST /api/location/sublocation_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
lc N Location Code
slc N Sub Location Code
sub_location N Sub Location Name. Wildcard search is available. You can use % in search query.

Typical API Call

curl -X POST $BASE_URL/api/location/sublocation_list -d userid=5 -d api_key="0f9895fb407c83e5ea128082098b47681aa75d6944576423c4" -d lc="NDL"


Sub Location create

POST /api/location/sublocation_create

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
lc Y Location Code.
slc Y New Sub Location Code.
sub_location Y New Sub Location Name

Sub Location Update

POST /api/location/sublocation_update

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
lc Y Location Code
slc Y Sub Location Code to be updated
new_slc N New Sub Location Code
new_sub_location N New Sub Location Name

Sub Location Delete

POST /api/location/sublocation_delete

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
lc Y Location Code
slc Y Sub Location Code to be deleted