Modify Subscriber Steering
Modify Subscriber Steering API is used to change steering tree of a subscriber per given provider.
|
HTTP URL |
|
|---|---|
|
PUT |
api/v2/subscriber/imsi/{value}/steering |
NOTE: Provided {type} must be of ‘imsi’ type. Any other input type (i.e., ‘iccid’, ‘msisdn’, ‘imei’, 'imeisv) will be rejected.
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 |
|---|---|---|---|
|
steering |
Numeric |
M |
Requested steering tree ID. |
API Response
Response Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
errorCode |
String |
O |
Failure code. |
|
errorMessage |
String |
O |
Failure message. |
|
content |
Object |
O |
Array of main response body object. Displayed when an API call was successful. For a failure it will be empty. |
|
pageable |
Object |
O |
Paging information object. Displayed when an API call was successful. For a failure it will be empty. |
Content data objects
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
requestId |
UUID |
M |
Request instance ID. To be used by external systems to query the call (operation) status, whether in progress, successful or failed. |
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
{
"steering": 13
}
Response Body: Success ACK
{
"errorCode": "",
"errorMessage": "",
"content": [
{
"requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}
Response Body: Failure NAK
{
"errorCode": "SUBSCRIBER_1002",
"errorMessage": "Subscriber does not exist",
"content": "",
"pageable": ""
}