dxp-ux

(0 reviews)

Activation (TMF-640)

/service

[PATCH]

This operation used to Activate and Configure Services or Resources.

URL

https://[localhost]:[port]/dxp-ux/v1/{businessId}/service/{id}

URL PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico	Y
id	string	Subscription Id/ Mobile Number	Y

name	value	description	required
client_id	string	The client_id identifying the channel.	Y
client_secret	string	Password associated with the client_id.	Y
X-Correlation-ID	string	An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request	Y
channelId	string	Expected value 'APP'	Y

Prepaid Request

{
   "serviceType":"activateSIM",
   "serviceCharacteristic":[
      {
         "name":"ICCID",
         "value":"5373"
      },
      {
         "name":"source",
         "value":"Digital"
      }
   ]
}

[ 200 ] Prepaid Response

OK - list request processed successfully, response body contains an entity corresponding to the requested resource.

{
  "id": "14282805321",
  "description":"SIM Activation in progress"
}

Postpaid Request

{
   "serviceType":"activateSIM",
   "serviceCharacteristic":[
      {
         "name":"ICCID",
         "value":"0358"
      },
      {
         "name":"source",
         "value":"Digital"
      }
   ]
}

[ 200 ] Postpaid Response

OK - list request processed successfully, response body contains an entity corresponding to the requested resource.

{
  "id": "14282805684",
  "description":"SIM Activation in progress"
}

PR - Call forward Request

Key Considerations for Call Forwarding:

Call Forward Sequence Steps

There are five possible patch operations namely "add, enable, disable, update and remove".
Each operation is distinguished based on provided action item.
Use Get Call to check status of customer call forwardDn.
Use patch call and action = 'add' to add call forwarding.
Use Get call to check status whether activated or not.
Use Patch call and action= 'update' to update call forwarding number. If required.
Use Get call to check status of updated number.
Use Patch call whenever it is required to Disable or Deactivate call forwarding action= 'disable'.
Use Get call to check the status of call forwarding is Disabled or not.
Use Patch call whenever it is required to Enable or Activate call forwarding action= 'enable'.
Use Get call to check the status of call forwarding is Enabled or not.
Use Patch call whenever it is required to remove call forwarding completely for customer dn, action = 'remove'

{
    "category": "fixed",
    "feature": [{
        "name": "Voice",
        "featureCharacteristic": [{
            "name": "callforward",
            "valueType": "object",
            "value": [{
                "action": "add",
                "forwardDn": "7879257004"
            }]
        }]
    }],
    "@type": "Feature"
}

[ 200 ] PR- Call forward Response

OK - request processed successfully, response body contains an entity corresponding to the requested resource.

{
    "description": "Service_Activated",
    "category": "fixed",
    "feature": [
        {
            "name": "Voice",
            "featureCharacteristic": [
                {
                    "id": "7875455880",
                    "name": "callforward",
                    "valueType": "object",
                    "value": [
                        {
                            "action": "enable",
                            "forwardDn": "7879257004"
                        }
                    ]
                }
            ]
        }
    ],
    "@type": "Feature"
}