PATCH geotab/device/alert

Update a geotab alert

Request Information

URI Parameters

None.

Body Parameters

A GeotabUpdateAlertRequest

GeotabUpdateAlertRequest
NameDescriptionTypeAdditional information
alertId

The id of the alert to be updated

unsigned integer

None.

serialNumber

The serial number of the device the alert belongs to

string

None.

alertType

The type of alert to setup

AlertNotificationTypeEnum

None.

emailEnabled

If you want emails sent on alert

boolean

None.

emailAddresses

The email any alerts will go to

Collection of string

None.

timeZone

The timezone of the alert

string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<GeotabUpdateAlertRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AlertId>1</AlertId>
  <SerialNumber>sample string 2</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>
</GeotabUpdateAlertRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A 200 on success

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.