...
"message": "Request Completed Successfully."
}
KPI:
This API is used to search KPI on the base of DN.
HTTP Method | GET |
URI | http://<adminpanel-server>:<port>/kpi/ServiceKPI/search?DN=4321 |
Content Type | Application/JSON |
HTTP Success Code | 200 |
HTTP Failure Code | 404,405 |
Parameters:
The api takes one parameter. Which is “DN” and it is required.
Parameter | Required | Description |
DN | true | Dial Number that is used to search KPIs and values related to it |
Sample Result parameters
Parameter | Expected Result | Description |
message | String | Displaying the Kpis and values related to dial number |
kpi | Array | Returns KPI array of objects |
values | Any numeric value | (i:e 2211) |
Status | Ok in case status is 200 etc | It shows the status of the request, whether it is completed successfully or not |
Example:
{
"Message": "Displaying the Kpis and values related to dial number",
"kpi": [
{
"kpi": {
"id": 6,
"name": "TEA_115",
"description": null,
"code": "1151"
},
"value": "240"
}
]
}
This API is used to check the list of available KPI Services
HTTP Method | GET |
URI | http://<adminpanel-server>:<port>/kpi/ServiceKPI?max={?} |
Content Type | Application/JSON |
HTTP Success Code | 200 |
HTTP Failure Code | 404,405 |
Parameters:
The api takes one parameter. Which is “max” and it is optional.
Parameter | Required | Description |
max | false | This parameter describes the number of KPI Services user want in each API call. It is an optional parameter, if not provided then API will simply fetch complete list of available KPI Services in Database. |
Sample Result parameters
Parameter | Expected Result | Description |
name | Name of the KPI Service | Name of KPI Service provided at creation time. |
description | Description | Tells about KPI Service description |
value | Any numeric value | (i:e 2231) |
kpi | Object | Object of KPI associated with KPI service |
dailNumbers | Array | Returns the list of DNs associated with KPI service |
Status | Ok in case status is 200 etc | It shows the status of the request, whether it is completed successfully or not |
Example:
[
{
"id": 1,
"name": "service_KPI",
"description": "Adding more KPI services",
"value": "111",
"kpi": {
"id": 2,
"name": "Add_KPI",
"description": "Adding more KPIs",
"code": "123"
},
"dialNumbers": [
"12",
"12345678"
]
}
]