GET apioauth/matrixv2/reminderalerts/{reminderalertId}
Get a vehicle reminder alert by id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
reminderalertId |
The alert id being queried |
unsigned integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A VehicleReminderAlertResponse
VehicleReminderAlertResponseName | Description | Type | Additional information |
---|---|---|---|
ReminderAlertId |
The id of the reminder alert |
unsigned integer |
None. |
ServiceId |
The service id the reminder is set against |
unsigned integer |
None. |
PushNotificationEnabled |
If you want mobile push notifications sent on alert |
boolean |
None. |
InboxMessageEnabled |
If you want an inbox message sent on alert |
boolean |
None. |
EmailEnabled |
If you want emails sent on alert |
boolean |
None. |
ReminderDate |
The date when the alert will be triggered |
date |
None. |
EarlyReminderDate |
The date when an early reminder will be triggered |
date |
None. |
PeriodicMonths |
If greater than 0 the reminder will be reset this many months after triggering |
integer |
None. |
ReminderType |
The type of the reminder |
ReminderType |
None. |
Response Formats
application/json, text/json
Sample:
{ "ReminderAlertId": 1, "ServiceId": 2, "PushNotificationEnabled": true, "InboxMessageEnabled": true, "EmailEnabled": true, "ReminderDate": "2025-04-27T16:39:58.2878137+00:00", "EarlyReminderDate": "2025-04-27T16:39:58.2878137+00:00", "PeriodicMonths": 8, "ReminderType": 0 }
application/xml, text/xml
Sample:
<VehicleReminderAlertResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ReminderAlertId>1</ReminderAlertId> <ServiceId>2</ServiceId> <PushNotificationEnabled>true</PushNotificationEnabled> <InboxMessageEnabled>true</InboxMessageEnabled> <EmailEnabled>true</EmailEnabled> <ReminderDate>2025-04-27T16:39:58.2878137+00:00</ReminderDate> <EarlyReminderDate>2025-04-27T16:39:58.2878137+00:00</EarlyReminderDate> <PeriodicMonths>8</PeriodicMonths> <ReminderType>MOT</ReminderType> </VehicleReminderAlertResponse>