cerillion-ux

1.0.x
(0 reviews)

TMF 640 Service Activation Management

Cerillion channel sends requests to cerillion-ux api which accepts only TMF requests for creation, updation and deletion of an account in plume. This functionality is related to replacing of single ONT device for Evolution products.

POST: /service

This endpoint is specific for creation of an account in plume which accepts request in TMF format from the channel. Mandatory parameters are accountId, macAddress and status. Below is the TMF640 request format received from channel.

curl --location 'https://esb-test.lla.com/cerillion-ux/v1/BB/service' \
--header 'client_id: *************************' \
--header 'client_secret: *****************' \
--header 'Content-Type: application/json' \
--data-raw '{
   "relatedEntity":[
  {
 "id":"******",
 "@referredType":"BillingAccount",
     "role":"relatedBillingAccount"
      }
   ],
   "supportingResource":[
      {
         "id":"*******",
         "name":"SerialNumber"
      }
   ],
   "feature":[
      {
         "name": "LogicalResource(ONT)",
         "featureCharacteristic":[
            {
               "name":"ServiceLevel",
               "value":"Basic"
            }
         ]
      }
   ]
}'

Request Parameter Definitions

  1. relatedEntity.id: Defines billableAccountNumber which is received from the channel and there is no length restriction applied for this field.
  2. relatedEntity.@referredType: Constant value "BillingAccount" received from channel.
  3. relatedEntity.role: Defines description of the account number as "relatedBillingAccount" which is a hardcoded value.
  4. supportingResource.id: Defines the MAC address / serial number of an ONT device.
  5. supportingResource.name: This field describes as serial number which is a value received from channel as SerialNumber.
  6. feature.name: Received from channel as "LogicalResource(ONT)".
  7. feature.featureCharacterstic.name: Received from channel as "ServiceLevel".
  8. feature.featureCharacterstic.value: Defines the state of an ONT as basicService or premiumService from the channel, for now the value would always be mapped as "Basic".

PATCH: /service/{id}

This endpoint is specific for updation of an account in plume which accepts request in TMF format from the channel. Mandatory parameters are accountId, macAddress and status. Below is the TMF640 request format received from channel.

curl --location 'https://esb-test.lla.com/cerillion-ux/v1/BB/service' \
--header 'client_id: *************************' \
--header 'client_secret: *****************' \
--header 'Content-Type: application/json' \
--data-raw '{
   "relatedEntity":[
      {
         "id":"******",
         "@referredType":"BillingAccount",
         "role":"relatedBillingAccount"
      }
   ],
   "supportingResource":[
      {
         "id":"*******",
         "name":"SerialNumber"
      }
   ],
   "feature":[
      {
         "name": "LogicalResource(ONT)",
         "featureCharacteristic":[
            {
               "name":"ServiceLevel",
               "value":"Basic"
            }
         ]
      }
   ]
}'

Request Parameter Definitions

  1. relatedEntity.id: Defines billableAccountNumber which is received from the channel and there is no length restriction applied for this field.
  2. relatedEntity.@referredType: Constant value "BillingAccount" received from channel.
  3. relatedEntity.role: Defines description of the account number as "relatedBillingAccount" which is a hardcoded value.
  4. supportingResource.id: Defines the MAC address / serial number of an ONT device.
  5. supportingResource.name: This field describes as serial number which is a value received from channel as SerialNumber.
  6. feature.name: Received from channel as "LogicalResource(ONT)".
  7. feature.featureCharacterstic.name: Received from channel as "ServiceLevel".
  8. feature.featureCharacterstic.value: Defines the state of an ONT as basicService or premiumService from the channel, for now the value would always be mapped as "Basic".

DELETE: /service/{id}

This endpoint is specific for deletion of an account in plume which accepts request in TMF format from the channel. For account deletion only billing AccountNumber is required which is passed as uri parameter.

URL
curl --location 'https://esb-test.lla.com/cerillion-ux/v1/BB/service' \ --header 'client_id: *************************' \ --header 'client_secret: *****************' \ --header 'Content-Type: application/json' \'

Key Considerations for CPE Plume integration

We recommend sending few static values from the channel like referredType, role, name. There is no length restriction applied on ESB level for the billingAccountNumber.

Note:
1. relatedEntity.id field will be sent with market prefix before the accoutNumber.
2. This API is applicable for cerillion markets (BB, BS, JM, TT, LC, VC, GD) though there is no restriction applied for market specific logic.
3. For LC & VC Markets businessId uri param is sent as BB from the channel and while sending to service-activation-configuration-biz market prefix from relatedEntity.id is picked for LC & VC Markets.
4. As the channel doesn't require the response payload from ESB, for all the 3 endpoints payload is cleared and 204 - No Content is set as response in ESB.

Reviews