Get Customer External Params
This API is used to retrieve a single instance or multiple instances of External Parameters, with their actual values, of any relevant entity (account, subscriber, plan) created by the user’s account.
Every API call retrieves instances of a single entity (UUID); hence, the entity type is provided in the URL.
|
HTTP URL |
|
|---|---|
|
GET |
/api/v2/customer/{id}/external-params/{entity}/{id} |
The {entity} valid ENUMs are customer, subscriber, plan. For example:/api/v2/customer/{id}/external-params/customer/a5ad9f06-0164-4475-8919-fcf1d4a4befe
The second {id} is the requested entity UUID (Customer, Subscriber or Offer) following the previous {entity} in the URL
Eligibility
The Requester is eligible to request information on External Parameters that were created by itself for its own account entities. The Requester is not eligible to request information on any other customer level, including its sub-accounts.
API Request
This API has no request structure.
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
|
Element |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
id |
UUID |
M |
External Parameter instance unique identifier |
|
extParamConfigId |
UUID |
M |
External Parameter Configuration unique identifier |
|
name |
String |
M |
External Parameter Configuration name |
|
displayName |
String |
O |
External Parameter Configuration name to display to the user |
|
value |
String |
O |
External Parameter value |
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 |
|---|---|
|
CUSTOMER_1002 |
Customer does not exist |
|
CUSTOMER_1023 |
Failed to retrieve external params details |
|
GLOBAL_1001 |
Service unavailable. Please try again |
Examples
Request Body
{
}Response Body: Success ACK
{
"errorCode": "",
"errorMessage": "",
"content": [
{
"id": "e7fcef24-5c03-41dd-9e33-995b7d6f47a7",
"extParamConfigId": "a5ad9f06-0164-4475-8919-fcf1d4a4befe",
"name": "externalSubscriberId",
"displayName": "External Subscriber Id",
"value": "13465798"
},
{
"id": "a3ad8f06-0164-4675-8919-fcf7d4a4bebe",
"extParamConfigId": "b8ad9f06-0104-9475-7919-ace1d4a4babe",
"name": "systemName",
"displayName": "System Name",
"value": "9876543212"
}
],
"pageable": {
"page": 1,
"size": 10,
"totalPages": 1,
"totalElements": 2
}
}Response Body: Failure NAK
{
"errorCode": "GLOBAL_1001",
"errorMessage": "Service unavailable. Please try again",
"content": "",
"pageable": ""
}