Send Requests

Use these guidelines when sending requests using the ECE REST API.

URL Structure

Here's the URL structure for the requests:

apiRoot/apiType/version/resourcePath

where:

• apiroot is for accessing the HTTP Gateway server at either http://hostname:httpPort or https://hostname:httpsPort.
• apiType and version are the type and version of the API:

  • For the Nchf Converged Charging endpoints, use nchf-convergedcharging/v2/.

  • For the Nchf Offline-Only Charging endpoints, use nchf-convergedcharging/v1/.

  • For the Nchf Spending Limit Control endpoints, use nchf-spendinglimitcontrol/v1/.

  • For the Usage Consumption endpoints, there is no apiType or version.

• resourcePath is the path to the endpoint.

For example, the URL for create a spending limit control subscription:

https://hostname:httpsPort/nchf-spendinglimitcontrol/v1/subscriptions

Supported Methods

You can perform create and read operations on a resource by using standard HTTP/HTTPS method requests, as summarized in the following table.

HTTP Method	Description
GET	Retrieve information about the resource.
POST	Create the resource.
DELETE	Delete the resource.
PUT	Update the entire resource, replacing the original.

Media Types

The following media types are supported by the ECE REST API:

• application/json

Supported Headers

The ECE REST API supports the following headers that may be passed in the header section of the HTTP/HTTPS request or response:

Header	Description	Example
Authority	The host name and port number of your Oracle Services Communications Proxy (SCP) Authority Server. Include this header if your system's communication model includes an SCP. For more information, see "Configuring Communication through SCP" in ECE Implementing Charging.	Authority: example.com:1534
Content-Type	Media type of the request body. This is required for POST and PUT requests.	Content-Type: application/json

Common Query Parameters

You can use the following common query parameters to limit the results returned by ECE REST API GET requests:

• offset: The number of results to offset the response by. Used in GET requests that return a list of results.
• limit: The maximum number of results to return. Used in GET requests that return a list of results.
• fields: The properties to show values for in the response. Used in all GET requests. The possible values for this parameter depend on the resource being requested. All properties of the resource will still appear in the response, but their values will be null. Depending on the endpoint, values for some required properties, such as IDs, will appear regardless of this parameter.

For example, a cURL request submitted to the Get Usage Consumption endpoint using all three of the above query parameters would look like this:

curl -X GET 'apiRoot/queryUsageConsumption?limit=5&offset=10&fields=id,href'

If there were more than 14 usage consumption report objects in the system, the response would include objects 10 through 14, and show the values for the id and href fields.

Note:

If you submit a request to a multischema BRM system, the response includes results from each schema. In the example above, in a two-schema system, the response would include five results from the first schema followed by five from the second schema.

Swagger URL

If you use Swagger, you can make calls to the ECE REST API at this URL:

apiroot/openapi-ui/index.html