Bulk Modify Subscriber Offer
This API is used to modify the attributes of an existing subscriber plan attached to multiple subscribers in a single call.
|
HTTP URL |
|
|---|---|
| PUT | /api/v2/bulk/subscriber/offer |
Eligibility
The Requester is eligible to modify a Regular plan of sub-customers’ subscribers or a Pool plan attached to sub-customers.
The Requester is not allowed to modify a plan of own subscribers.
API Request
Request Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
bulk |
Object |
M |
Array of main request body object. |
Bulk data objects
|
Element |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
subscriberIdentifiers |
Object |
M |
Subscriber unique keys object, defines the search criteria |
|
content |
Object |
M |
Main elements container object |
subscriberidentifiers data objects
|
Element |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
type |
String |
M |
Define the search criteria. ENUMs: IMSI, ICCID, MSISDN, IMEI |
|
value |
String |
M |
Type value. IMSI or ICCID or MSISDN or IMEI number. |
Content data objects
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
subscriberOfferingId |
UUID |
M |
Subscriber offer ID |
|
priority |
Numeric |
O |
Plan order of priority; the higher the numeric value, the higher priority the plan receives. For example, a plan with priority 100 precedes plan with priority 50. The Rater does not enforce the sequential order of any plan’s priorities and so it has no meaning. Note: The Rater does not enforce the uniqueness of an assigned priority between a subscriber’s plans. Therefore, prevent sending an existing plan’s priority value to this plan. |
|
expirationDate |
Date |
O |
Determines the requested date as per the selected expirationType set when plan created. Can be used only if the expirationType parameter has been set to FIXED. Rejected for other expirationType settings. |
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 data objects
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
errorCode |
String |
O |
Failure code. |
|
errorMessage |
String |
O |
Failure message. |
|
requestId |
UUID |
CM |
Request instance ID. To be used by external systems to query the call (operation) status: In progress Successful 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 |
O |
Main response body object that reflects a single node of the original request. |
subscriberidentifiers data objects
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
type |
String |
M |
Define the search criteria. ENUMs: IMSI, ICCID, MSISDN, IMEI |
|
value |
String |
M |
Type value. IMSI or ICCID or MSISDN or IMEI number. |
Content data objects
|
Element |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
subscriberOfferingId |
UUID |
M |
Subscriber offer ID |
|
priority |
Numeric |
O |
Plan order of priority; the higher the numeric value, the higher priority the plan receives. |
|
expirationDate |
Date |
O |
Newly requested expiration date as per the selected expirationType set when plan created. |
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_1026 |
Failed to modify offer |
Examples
Request Body
{
"bulk": [
{
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090961859"
},
"content": {
"subscriberOfferingId": "4543dedb-cce7-4bee-89f3-7af1447927e6",
"priority": 100,
"expirationDate": "25042023"
}
},
{
"subscriberIdentifiers": {
"type": "ICCID",
"value": "8935711001000034535"
},
"content": {
"subscriberOfferingId": "e7fcef24-5c03-41dd-9e33-995b7d6f47e2",
"priority": 100,
"expirationDate": "25042023"
}
}
]
}Response Body: Full Success ACK
{
"bulk": [
{
"errorCode": "",
"errorMessage": "",
"requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370",
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090961963"
},
"content": {
"subscriberOfferingId": "4543dedb-cce7-4bee-89f3-7af1447927e6",
"priority": 100,
"expirationDate": "25042023"
}
},
{
"errorCode": "",
"errorMessage": "",
"requestId": "7e74dce6-8eef-4c86-a4bb-1a860913c271",
"subscriberIdentifiers": {
"type": "ICCID",
"value": "8935711001000035687"
},
"content": {
"subscriberOfferingId": "e7fcef24-5c03-41dd-9e33-995b7d6f47e2",
"priority": 100,
"expirationDate": "25042023"
}
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}Response Body: Includes Failure(s) (NAK)
{
"bulk": [
{
"errorCode": "SUBSCRIBER_1026",
"errorMessage": "Failed to modify offer",
"requestId": "",
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090961963"
},
"content": {
"subscriberOfferingId": "4543dedb-cce7-4bee-89f3-7af1447927e6",
"priority": 100,
"expirationDate": "25042023"
}
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}