Back to API parent page

Method: cancel-alarm

Cancel a registered alarm.

Sample Response

<response>
  <version>2</version>
  <code>200</code>
  <text>OK</text>
  <currentTime>1270614730908</currentTime>
  <data>
    <references/>
  </data>
</response>

Request Parameters

  • id - the alarm id is encoded directly in the URL
    • http://api.onebusaway.org/api/where/cancel_alarm/[ID GOES HERE].xml

The alarm id is returned in the call to register-alarm-for-arrival-and-departure-at-stop api method.