Bulk Move Subscriber
This API is used to move multiple Subscribers from their current customers to new customers with a single API call.
| HTTP URL | |
|---|---|
| PUT | /api/v2/bulk/subscriber/move |
Eligibility
The Requester is eligible to request to move subscribers attached to itself and to its sub-customers; the Requester is also allowed to move a subscriber back from any sub-customer level directly to the Requester customer.
No other alternative is allowed.
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 |
|---|---|---|---|
|
targetCustomerId |
UUID |
M |
New parent customer 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 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 |
|---|---|---|---|
|
targetCustomerId |
UUID |
M |
New parent customer 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 |
|
SUBSCRIBER_1002 |
Subscriber does not exist |
|
CUSTOMER_1008 |
Failed to find target customer |
Examples
Request Body
{
"bulk": [
{
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090961859"
},
"content": {
"targetCustomerId": "4543dedb-cce7-4bee-89f3-7af1447927e6"
}
},
{
"subscriberIdentifiers": {
"type": "ICCID",
"value": "8935711001000034535"
},
"content": {
"targetCustomerId": "e7fcef24-5c03-41dd-9e33-995b7d6f47e2"
}
}
]
}Response Body: Full Success ACK
{
"bulk": [
{
"errorCode": "",
"errorMessage": "",
"requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370",
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090961859"
},
"content": {
"targetCustomerId": "4543dedb-cce7-4bee-89f3-7af1447927e6"
}
},
{
"errorCode": "",
"errorMessage": "",
"requestId": "7e74dce6-8eef-4c86-a4bb-1a860913c271",
"subscriberIdentifiers": {
"type": "ICCID",
"value": "8935711001000034535"
},
"content": {
"targetCustomerId": "e7fcef24-5c03-41dd-9e33-995b7d6f47e2"
}
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}Response Body: Includes Failure(s) (NAK)
{
"bulk": [
{
"errorCode": "CUSTOMER_1008",
"errorMessage": "Failed to find target customer",
"requestId": "",
"subscriberIdentifiers": {
"type": "IMSI",
"value": "222013090961859"
},
"content": {
"targetCustomerId": "4543dedb-cce7-4bee-89f3-7af1447927e6"
}
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}