The article includes:
This will provide you with detailed information for an EAP such as features, plans, thresholds, custom field settings, and other attributes.
Note: Use queryEAPCodes for a list of your account's EAP codes.
| Request URL (production) | https://prismproapi.koretelematics.com/4/TransactionalAPI.svc/json/queryEAPDetails |
| Request URL (sandbox) | https://prismproapi.sandbox.koretelematics.com/4/TransactionalAPI.svc/json/queryEAPDetails |
| Request method | Post |
Request
| Field | Data type | Mandatory | Min length | Max length | Description |
| EAPCode | string | Y | 6 | 18 | The EAP code. |
JSON request example
{
"EAPCode": "EAP000001"
}
Response
| Parameter name | Data type | Min length | Max length | Description |
| requestStatus | int | Request status code. | ||
| customerEAPName | string | EAP name. | ||
| customerEAPDescription | string | EAP description. | ||
| EAPStatus | string | EAP status | ||
| dateActivated | datetime | YYY-MM-DD HH-MM-SS | ||
| dateDeactivated | datetime | |||
| lstFeatures | string[] | 10 | 10 each | Feature code:Feature name |
| dailyDataThreshold | int | Daily data threshold. | ||
| dailySMSThreshold | int | Daily SMS threshold. | ||
| monthlyDataThreshold | int | Monthly data threshold | ||
| monthlySMSThreshold | int | Monthly SMS threshold | ||
| serviceType | string | 20 | Service type | |
| dataPlan | string | Plan code. | ||
| SMSPlan | string | Plan code. | ||
| voiceDispatchNumber | string | 20 | ||
| workOrderEmail | string | 50 | Alert email. | |
| workOrderCCEmail | string | 50 | Alert cc: email. | |
| custom1 | string | 64 | custom 1 field. | |
| custom2 | string | 64 | custom 2 field. | |
| custom3 | string | 64 | custom 3 field. | |
| custom4 | string | 64 | custom 4 field. | |
| custom5 | string | 64 | custom 5 field. | |
| custom6 | string | 64 | custom 6 field. |
JSON request example
{
"d": {
"__type": "EAPInformation:https://PRiSMProAPI.koretelematics.com/types",
"requestStatus": 0,
"customerEAPName": "EAP Name",
"customerEAPDescription": "",
"EAPStatus": "Enabled",
"dateActivated": "/Date(1459374164253-0400)/",
"dateDeactivated": null,
"lstFeatures": [
"FEAT000001: Feature Name1",
"FEAT000002: Feature Name2"
],
"dailyDataThreshold": 10,
"dailySMSThreshold": 10,
"monthlyDataThreshold": 100,
"monthlySMSThreshold": 100,
"serviceType": "SERVICE TYPE NAME",
"dataPlan": "PLAN000001: Plan Name",
"SMSPlan": "PLAN000001: Plan Name",
"voiceDispatchNumber": "",
"workOrderEmail": "demo@koretelematics.com",
"workOrderCCEmail": "",
"custom1": null,
"custom2": null,
"custom3": null,
"custom4": null,
"custom5": null,
"custom6": null
}
}