POST geotab/device/alert

Create a geotab alert and confirmation email

Request Information

URI Parameters

None.

Body Parameters

A GeotabCreateAlertRequest

Name	Description	Type	Additional information
serialNumber	The serial number of the alert	string	None.
alertType	The type of alert to setup - 7 is removed, 17 low battery and 19 is movement	AlertNotificationTypeEnum	None.
emailEnabled	If you want emails sent on alert	boolean	None.
emailAddresses	The email addresses any alerts will go to	Collection of string	None.
timeZone	The timezone of the alert	string	None.

Request Formats

application/json, text/json

Sample:

{
  "serialNumber": "sample string 1",
  "alertType": 0,
  "emailEnabled": true,
  "emailAddresses": [
    "sample string 1",
    "sample string 2"
  ],
  "timeZone": "sample string 3"
}

application/xml, text/xml

Sample:

<GeotabCreateAlertRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SerialNumber>sample string 1</SerialNumber>
  <AlertType>Heartbeat_Voltage</AlertType>
  <EmailEnabled>true</EmailEnabled>
  <EmailAddresses>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </EmailAddresses>
  <Timezone>sample string 3</Timezone>
</GeotabCreateAlertRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A GeotabCreateAlertResponse

GeotabCreateAlertResponse

Name	Description	Type	Additional information
alertId	The id of the newly created alert	unsigned integer	None.

Response Formats

application/json, text/json

Sample:

{
  "alertId": 1
}

application/xml, text/xml

Sample:

<GeotabCreateAlertResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AlertId>1</AlertId>
</GeotabCreateAlertResponse>