The ESPF API contains methods to retrieve the list of service groups available to store account provisioning status and to add and delete custom service groups. Use these HTTP methods to manage service groups:
- GET – to get the service group list;
- POST – to add a new custom service group;
- DELETE and POST – to delete a custom service group. DELETE is the recommended method.
get_group_list
Use this method to retrieve the list of service groups defiend for ESPF from the database.
The URL to send requests to is:
https://<portabilling-web.yourdomain.com>/espf/v1/groups
The response includes these attributes in JSON format:
|
Attribute |
Type |
Description |
|---|---|---|
|
group_list |
Array of GroupList structure |
The list of service groups registered in PortaBilling |
GroupList structure
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
string |
A service group name |
|
i_group |
int |
The unique ID of a service group |
|
is_custom |
string |
Indicates whether a service group is the predefined or a custom one. Possible values:
|
Request example:
|
GET /espf/v1/groups HTTP/1.1 Authorization: Basic dXNlciBwQHNzdzByZA== User-Agent: curl/7.29.0 Host: 192.168.248.32 Accept: */* Content-Type: application/json |
Response example:
|
{ “group_list”:[ { “i_group”:”1″, “name”:”VoIP”, “is_custom”:false }, { “i_group”:”2″, “name”:”HSS”, “is_custom”:false }, { “i_group”:”3″, “name”:”PCRF”, “is_custom”:false }, …… { “i_group”:”1001″, “name”:”IOT”, “is_custom”:true } ] } |
create_group
Use this method to add a custom service group to the database.
The URL to send requests to is:
https://<portabilling-web.yourdomain.com>/espf/v1/group/create
The body of the request must include the service group name.
The response contains the information about a new group in JSON format:
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
string (max 64 chars) |
A service group name |
|
i_group |
int |
The unique ID of the service group |
Request example:
|
POST /espf/v1/group/create HTTP/1.1 Authorization: Basic dXNlciBwQHNzdzByZA== Host:demo.portaone.com Content-Type: application/x-www-form-urlencoded Content-Length: 8 name=DPI |
Response example:
|
{ “group”:{ “i_group”:”1002″, “name”:”DPI” } } |
delete_group
Use this method to remove a service group from PortaBilling. You can delete only custom groups. Upon method execution the group specified is marked as obsolete in the database.
The URL to send requests to is:
https://<portabilling-web.yourdomain.com>/espf/v1/group/<name>
where: <name> is the name of a custom service group.
