Get Customer External Params Config

Get Customer External Params 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, package) created by the user’s account. Every API call retrieves instances per a single entity (UUID) hence entity type provided in the URL.

HTTP URL

 
GET /api/v2/customer/{id}/external-params-config

NOTE: {entity} can be one of the following ENUMs: ‘customer’, ’subscriber’, ’plan’, ‘package’. To retrieve a ‘Product’ related External Param value, use ‘plan’ entity. Example: api/v2/customer/{id}/external-params-config/customer/a5ad9f06-0164-4475-8919-fcf1d4a4befe.

NOTE: Second {id} is the requested entity UUID (Customer [sub-account], Subscriber, or Offer or Package) following the {entity} provided in the URL right before.

Eligibility

The Requester is eligible to request information on External Parameters configuration items 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 Configuration unique identifier
name String M External Parameter Configuration name
displayName String O External Parameter Configuration name to display to the user
Description String O External Parameter Configuration description
entityType String M

External Parameter Configuration type. ENUM valid values: CUSTOMER, SUBSCRIBER, OFFER, PACKAGE
isSearchable Boolean M

Determines whether the external parameter can be found by search.

  • True: Can be searched and retrieved by the query
  • False: Hidden. Wil not be retrieved by the query

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_1019

Failed to retrieve external params config details

GLOBAL_1001

Service unavailable. Please try again

Examples

Request Body

Copy 
{
}

Response Body: Success ACK

Copy 
{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "id": "e7fcef24-5c03-41dd-9e33-995b7d6f47a7",
      "name": "externalSubscriberId",
      "displayName": "External Subscriber Id",
      "description": "The Id of the subscriber in external billing system",
      "entityType": "CUSTOMER",
      "isSearchable": true
    },
    {
      "id": "a3ad8f06-0164-4675-8919-fcf7d4a4bebe",
      "name": "systemName",
      "displayName": "System Name",
      "description": "The name of external billing system",
      "entityType": "OFFER",
      "isSearchable": false
    }
  ],
  "pageable": {
    "page": 1,
    "size": 10,
    "totalPages": 1,
    "totalElements": 2
  }
}

Response Body: Failure NAK

Copy 
{
  "errorCode": "GLOBAL_1001",
  "errorMessage": "Service unavailable. Please try again",
  "content": "",
  "pageable": ""
}