This API provides the ability to send email and SMS Alert Notification to predefined distribution lists that can be set on Account Properties with names “hos.alert.emails” and hos.alert.phonenumbers”, respectively.
Fields
| Tag |
Data Type |
Required |
Description |
| details |
Text |
Yes |
Details of the event that triggered the Aert Notification |
| driverName |
Text |
Yes |
The name of the Driver that triggered the Alert Notification |
| notificationType |
Text |
Yes |
The type of Alert Notification to be sent. Can either be:
- Violation
- Violation Warning
- Pre Trip Dvir Not Completed
- DVIR Failure
- Unidentified Driving Alert
- Document Saved
- DVIR Defects
|
| timestamp |
Text |
Yes |
Indicates the date and time as to when the Alert Notification was triggered.
Note: Format is in timestamp and timezone (YYYY-MM-DDTHH:MM:SS.sssZ, e.g: 1970-01-01T00:00:00.000Z) |
Create
| API PATH: |
/api/v2/alertNotification |
| METHOD: |
POST |
| EXAMPLE RESPONSE: |
{
"notificationType": "Violation",
"timestamp": "2018-06-11T12:00:00.000Z",
"details": "Driving Hours In Shift",
"driverName": "Driver Test"
}
|
API error calls
| ERROR MESSAGE |
POSSIBLE CAUSES |
| GET is not supported. |
GET method is not allowed |
| PUT is not supported. |
PUT method is not allowed |
| DELETE is not supported. |
DELETE method is not allowed |
