Bulk Modify Subscriber PCRF Settings
This API is used to change multiple providers’ (IMSIs) web surfing bandwidth in the floLIVE core network (PCRF).
|
HTTP URL |
|
|---|---|
| PUT | /api/v2/bulk/subscriber/pcrf |
Eligibility
The Requestor is eligible to modify his own subscribers’ SIM settings information regardless of their actual existence (which level they reside in).
API Request
Request Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
bulk |
Object |
M |
Array of main request body object. |
bulk object
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
subscriberIdentifiers |
Object |
M |
Subscriber unique keys object, defines the search criteria. |
|
content |
Object |
M |
Main elements container object |
subscriberIdentifiers object
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
type |
String |
M |
Defines the search criteria. Only valid type ENUM is: ‘IMSI’. |
|
value |
String |
M |
Type value. IMSI number. |
content object
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
throttlingGroupId |
Numeric |
O |
Set the PCRF throttling group in the floLIVE core network |
API Response
Response Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
bulk |
Object |
M |
Array of main response body object. |
|
pageable |
Object |
O |
Paging information object displayed when an API call was successful. For a failure, it will be empty. |
bulk object
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
errorCode |
String |
O |
Failure code. See list below, under ‘Error Codes’ section. |
|
errorMessage |
String |
O |
Failure detailed description. See list below, under ‘Error Codes’ section. |
|
requestId |
UUID |
CM |
Request instance ID. To be used by external systems to query the call (operation) status, whether in progress, successful or failed. Displayed when an API call was successful. For a failure, it will be empty. |
|
subscriberIdentifiers |
Object |
M |
Subscriber unique keys object, defines the search criteria. |
|
content |
Object |
M |
Main response body object. Reflects a single node of the original request. |
subscriberIdentifiers object
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
type |
String |
M |
Defines the search criteria. Only valid type ENUM is: ‘IMSI’. |
|
value |
String |
M |
Type value. IMSI number. |
content object
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
throttlingGroupId |
Numeric |
O |
PCRF throttling group in the floLIVE core network |
Pageable data objects
|
Element |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
page |
Numeric |
M |
Page number |
|
size |
Numeric |
M |
Page size. Number of requested elements per page |
|
totalPages |
Numeric |
M |
Total amount of available pages per requested page size |
|
totalElements |
Numeric |
M |
Total amount of retrieved elements |
Error Codes
In addition to the general success and failure codes, the following error codes are possible.
|
Code |
Message |
|---|---|
|
GLOBAL_1001 |
Service unavailable. Please try again |
|
SUBSCRIBER_1002 |
Subscriber does not exist |
Examples
Request Body
{
"bulk": [
{
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090961859"
},
"content": {
"throttlingGroupId": 13
}
},
{
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090961860"
},
"content": {
"throttlingGroupId": 13
}
}
]
}Response Body: Full Success ACK
{
"bulk": [
{
"errorCode": "",
"errorMessage": "",
"requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370",
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090961859"
},
"content": {
"throttlingGroupId": 13
}
},
{
"errorCode": "",
"errorMessage": "",
"requestId": "7e74dce6-8eef-4c86-a4bb-1a860913c271",
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090961860"
},
"content": {
"throttlingGroupId": 13
}
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}Response Body: Includes Failure/s NAK
{
"bulk": [
{
"errorCode": "SUBSCRIBER_1002",
"errorMessage": "Subscriber does not exist",
"requestId": "",
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090961859"
},
"content": {
"throttlingGroupId": 13
}
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}