Create Customer External Params Config

This API is used to create one or more new External Parameters configuration items for its own customer and for a given entity (Customer, Subscriber, Offer, Package) in a single call. When sending a request to create multiple External Parameters Configuration items in a single call, the result treats them as a single instance so that the result is either All Succeed, or All Fail.

The System limits the number of External Parameters Configuration items to five items per entity.

HTTP URL  
POST /api/v2/customer/{id}/external-params-config/{entity}

NOTE: The {entity} valid ENUMs are customer, subscriber, package plan. For example: /api/v2/customer/{id}/external-params-config/customer

Eligibility

The Requester is eligible to create new External Parameters Configuration for its own customer entities only (sub-customers, its own subscribers, Sell plans, Sell packages). The Requester is not eligible to create new External Parameters Configuration items at any other customer level.

API Request

Request Structure

Parameter Type M/O/CM Description
externalParamsConfig Object M Array of External Parameter Configuration Object

externalParamsConfig data objects

Parameter Type M/O/CM Description
name String M

External Parameter Configuration name.

Must be unique per entity.
displayName String O External Parameter Configuration name to display to the user
Description String O External Parameter Configuration description
isSearchable Boolean O

Determines whether the external parameter can be found by search.

  • True: Can be searched and retrieved by the RSQL query

  • False: Hidden. Will not be retrieved by the RSQL query

  • Default: True

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 Objec 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
requestId UUID M

Request instance ID. To be used by external systems to query the call (operation) status:

  • In progress

  • Successful

  • 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
CUSTOMER_1020 Failed to create external params config item
GLOBAL_1001 Service unavailable. Please try again
GLOBAL_1019 Invalid entity name specified

Examples

Request Body

Copy 
{
  "externalParamsConfig": [
    {
      "name": "externalCustomerId",
      "displayName": "External Customer Id",
      "description": "The Id of the customer in external billing system",
      "isSearchable": true
    },
    {
      "name": "systemName",
      "displayName": "System Name",
      "description": "The name of external billing system",
      "isSearchable": false
    }
  ]
}

Response Body: Success ACK

Copy 
{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Failure NAK

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