Policy profile operations

Endpoint

/pcc/pcrf/policy-profiles

API endpoints related to obtaining information about policy profiles. This includes creating, retrieving, updating, and deleting profiles.

Create policy profile

Creates a new policy profile.

post /pcc/pcrf/policy-profiles

Header
Content-type

JSON

Accept

JSON

Permissions

PCRF_POLICY_PROFILES_CREATE_PERMISSION

Request

Below is a request example. See the descriptions below for more details on the fields.

{
  "id" : 4711,
  "name" : "BaseProfile",
  "description" : "a base profile",
  "status" : "active",
  "serviceProfileId" : 111,
  "qosProfileId" : 222,
  "chargingProfileId" : 333,
  "deviceProfileId" : 444,
  "locationProfileId" : 555,
  "timeProfileId" : 666,
  "networkProfileId" : 777,
  "created" : "2020-06-07T13:10:00Z",
  "updated" : "2020-06-08T14:20:00Z"
}

Response

If successful, returns a 201 HTTP code and the newly-created resource body. Otherwise, check the response codes below.

Retrieve policy profile

Retrieves an existing policy profile’s information. Specify an ID to retrieve a specific profile or retrieve all with no ID specified. Use query parameters to paginate the response when retrieving all. For example, /pcc/pcrf/policy-profiles?page=0&size=100.

get /pcc/pcrf/policy-profiles/id

Header
Content-type

JSON

Accept

JSON

Permissions

PCRF_POLICY_PROFILES_READ_PERMISSION

Response

If successful, returns a 200 HTTP code and the resource body. Otherwise, check the response codes below.

Update policy profile

Updates a policy profile.

put /pcc/pcrf/policy-profiles/id

Header
Content-type

JSON

Accept

JSON

Permissions

PCRF_POLICY_PROFILES_UPDATE_PERMISSION

Request

Below is a request example. See the descriptions below for more details on the fields.

{
  "id" : 4711,
  "name" : "BaseProfile",
  "description" : "a base profile",
  "status" : "active",
  "serviceProfileId" : 111,
  "qosProfileId" : 222,
  "chargingProfileId" : 333,
  "deviceProfileId" : 444,
  "locationProfileId" : 555,
  "timeProfileId" : 666,
  "networkProfileId" : 777,
  "created" : "2020-06-07T13:10:00Z",
  "updated" : "2020-06-08T14:20:00Z"
}

Response

If successful, returns a 200 HTTP code and the updated resource body. Otherwise, check the response codes below.

Delete policy profile

Deletes a policy profile.

delete /pcc/pcrf/policy-profiles/id

Header
Content-type

JSON

Accept

JSON

Permissions

PCRF_POLICY_PROFILES_DELETE_PERMISSION

Response

If successful, returns a 204 HTTP code. Otherwise, check the response codes below.

PCRF API JSON descriptions

Field Description

id

The ID of the Policy profile.

Found in the response only.

name

The name of the Policy profile.

Required in request payload.

description

A description of the Policy profile.

status

The Policy profile’s status.

Required in request payload.

serviceProfileId

The service profile ID.

qosProfileId

The QoS profile ID.

chargingProfileId

The charging profile profile ID.

deviceProfileId

The device profile ID.

locationProfileId

The location profile ID.

timeProfileId

The time profile ID.

networkProfileId

The network profile ID.

created

The time the Policy profile was created in ISO format.

updated

The time the Policy profile was updated in ISO format.

PCRF API response codes

If you receive an HTTP status code of 400, your request does not confirm to the API specification. Check the endpoint is correct and your header information is set to use JSON.

If you receive an HTTP status code of 422, there is a processing error. More information is provided in the codes below.

Code Description

1

The name is not unique.

example

You try to create a Policy profile with the name Base and there is already a Policy profile with this name.

2

Unknown service profile.

example

You try to create a Policy profile with a service profile ID that doesn’t exist.

3

Unknown QoS profile.

example

You try to create a Policy profile with a QoS profile ID that doesn’t exist.

4

Unknown charging profile.

example

You try to create a Policy profile with a charging profile ID that doesn’t exist.

5

Unknown status.

example

You try to create a Policy profile with a status that does not exist.

6

Unknown device profile.

7

Unknown location profile.

8

Unknown time profile.

9

Unknown network profile.