cdp.rateplan.list
The cdp.rateplan.list command is used to acquire the list of rate plans available for all connections of a specific CDP configuration, or for a specific connection.
TR50 Request
{
"1": {
"command": "cdp.rateplan.list",
"params": {
"configId": "500000000000000000000001"
}
}
}
Request Parameters
Name | Type | Required | Description |
---|---|---|---|
id | String | Yes* | The identifier of the connection. |
esn | String | ESN of the connection. | |
iccid | String | ICCID of the connection. | |
imei | String | IMEI of the connection. | |
imsi | String | IMSI of the connection. | |
meid | String | MEID of the connection. | |
msisdn | String | MSISDN of the connection. | |
*One of the above parameters is required to identify the connection. | |||
showAll | Boolean | Yes | If set to true, it will return plans of all CDP configs. |
TR50 Response
If the command is sent successfully a success message is returned. Otherwise, an error and error message will be returned.
{
"1":{
"success":true,
"params":{
"result":[
{
"configId":"500000000000000000000001",
"id":9876,
"name":"Plan 01",
"networkId":1001,
"networkName":"NewNetwork",
"planCode":"01234"
},
...
]
}
}
}
Response Parameters
Name | Type | Description |
---|---|---|
configId | String | When the showAll parameter is specified, this will contain the configId the plan is associated with (optional). |
id | Integer | The ID the rate plan (optional). |
name | String | The name of the rate plan (required). |
networkId | Integer | The network identifier of the rate plan (optional). |
networkCode | String | The code of the network (optional). |
networkName | String | The name of the network (optional). |
planCode | String | The code of the rate plan (optional). |