Bulk Subscriber Steering
Bulk Modify Subscriber Steering API is used to change steering tree of a subscriber per given provider of multiple subscribers in a single call.
|
HTTP URL |
|
|---|---|
|
PUT |
api/v2/bulk/subscriber/steering |
Eligibility
The Requestor is eligible to request a steering tree change for his own subscribers..
API Request
Request Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
bulk |
Object |
M |
Array of main request body object. |
|
subscriberIdentifiers |
Object |
M |
Main elements container object |
Subscriber Identifiers
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
type |
String |
M |
Define the search criteria. Only valid type ENUM is: ‘IMSI’ |
|
value |
String |
M |
Type value. IMSI number. |
Content
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
steering |
Numeric |
M |
Requested steering tree ID. |
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
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
errorCode |
String |
O |
Failure code |
|
errorMessage |
String |
O |
Failure detailed description |
|
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 original request. |
Subscriber Identifiers
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
type |
String |
M |
Defines the search criteria. Valid type ENUM is: ‘IMSI’. |
|
value |
String |
M |
Type value. IMSI number. |
Content
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
steering |
Numeric |
M |
Requested steering tree ID. |
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 |
|
GLOBAL_1002 |
Subscriber does not exist |
Examples
Request Body
{
"bulk": [
{
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090961859"
},
"content": {
"steering": 10
}
},
{
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090966359"
},
"content": {
"steering": 2504
}
}
]
}
Response Body: Success ACK (includes failure NAK)
{
"bulk": [
{
"errorCode": "SUBSCRIBER_1002",
"errorMessage": "Subscriber does not exist",
"requestId": "",
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090961963"
},
"content": {
"steering": 2504
}
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}
Response Body: Failure NAK
{
"errorCode": "SUBSCRIBER_1002",
"errorMessage": "Subscriber does not exist",
"content": "",
"pageable": ""
}