Sending provisioning status for an account via ESPF API

Link copied to clipboard

When the Application receives the response from the external system, it connects to the ESPF via the API and sends the HTTPS POST request to update the provisioning status for an account in PortaBilling database.

The ESPF API is available under this URL:

https://<portabilling-web.yourdomain.com>/espf/v1/account/i/<i_account>/status

where:

  • portabilling-web.yourdomain.com is the hostname of your PortaBilling web server;
  • v1 is the provisioning API version;
  • i_account is the unique ID of the PortaBilling account; and
  • status is the account’s provisioning status.

If you operate with account ID rather than i_account, then the URL changes to

https://<portabilling-web.yourdomain.com>/espf/v1/account/<id>/status

Authorization is done using the API credentials of the PortaBilling administrative user via one of the available authentication methods.

The Content-Type header field used with a HTTPS POST request must be of the application/x-www-form-urlencoded type.

The body of the request must include these parameters:

Attribute

Mandatory

Type

Description

status

Y

string

The account’s provisioning status. Possible values:

  • OK – the provisioning is successful;
  • IN_PROGRESS – the provisioning is in progress;
  • RETRY – a retry is initiated after an initial failure;
  • FAILED – the provisioning failed.

group

Y

string

A service group organizes the provisioning requests per the external system (e.g., the IPTV group is used to identify provisioning requests to an IPTV platform). When the Application sends the API requests with the account’s provisioning statuses, they are distinguished and stored under the corresponding service group name.

You can use any group name to store the account’s provisioning status. First, register this group in PortaBilling and then pass its name to the ESPF in the API request. Please refer to the Manage service groups section for details.

These groups are pre-defined in PortaBilling:

  • VoIP ;
  • HSS;
  • PCRF;
  • IPTV;
  • WiMAX;
  • Netaccess;
  • NumberPortability; and
  • LawfulInterception.

error

N

string (max 4000 chars)

The message that describes the failed result of setting an account’s provisioning status. This attribute is ignored for the OK status value.

Here is an example of the POST request:

POST /espf/v1/account/i/189/status HTTP/1.1

Host: demo.portaone.com

Content-Type: application/x-www-form-urlencoded

Content-Length: 19

status=OK&group=HSS

The response from the ESPF contains the HTTP Status Code.

On this page