Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
/alert/

...

{alert_id}
Info

Retrieves Modifies a specific alert, or a channel of alerts, or all channels available to the user if channel_id is not provided. (TODO: UPDATE)alerts for a user

Note: alert_type_id can be created/found in the settings api call

Possible Methods

GET POST PUT DELETE

Arguments
(TODO: UPDATE)

alert_id(optional)
Alert id to modify

Parameters

channel_id (optional)
Channel id to try and return, if not provided returns all channels for current userfilter results on, always trumps channel_id in payload
Note: If provided in a GET call, will update last_requested_time to NOW (returning the original object), this is used in the GUI to determine flags for showing alert changes

Json Object
(TODO: UPDATE)
Code Block
{
        "channelString alert_id";
: "531733e8b8e08e9d2197b0b0",   	String event_id;
    "events" : [],	String channel_id;
    	String alert_type_id;
   "locations" : [],	Date last_alert_time;
    	long next_possible_alert_time_ms;
  "name" : "abc123"		Date last_requested_time;
}

 

Example

...

Code Block
curl -b cookies.txt -X GET "http://localhost:8185/channelalert/532af74cb8e0870ad33d94cd" > response.txt
curl -b cookies.txt -X GET "http://localhost:8185/channel/531733e8b8e08e9d2197b0b0alert/532af74cb8e0870ad33d94cd?channel_id=531f3e50b8e0a93944925594" > response.txt
curl -b cookies.txt -X POST -d '{"nameevent_id":"abc12352e2e833e4b013563c3ea1ee"}',  "http://localhost:8185/channel" > response.txt
curl -b cookies.txt -X PUT-d '{"name":"renamed my channel"alert_type_id":"532af8d8b8e0dd9b47dea7f8"}'  "http://localhost:8185/channel/531733e8b8e08e9d2197b0b0alert" > response.txt
curl -b cookies.txt -X PUT -d '{"channelevent_id":"531733e8b8e08e9d2197b0b052e2e833e4b013563c3ea1ee", "namealert_type_id":"renamed my channel532af8d8b8e0dd9b47dea7f9"}'  "http://localhost:8185/channelalert" > response.txt
curl -b cookies.txt -X DELETE -d '{"channel":"531733e8b8e08e9d2197b0b0"}'  "http://localhost:8185/alert/channel532af74cb8e0870ad33d94cd" > response.txt

 

Example Response
Info
curl -b cookies.txt -X DELETEGET "http://localhost:8185/channelalert/531733e8b8e08e9d2197b0b0532af911b8e0dd9b47dea7fa" > response.txt

 

...

Example Response
(TODO: UPDATE)
 

Info
Code Block
Code Block
 {
    "response": {
        "action": "Alert",
        "success": true,
        "message": "Return specific alert: 532af911b8e0dd9b47dea7fa",
        "time": 0
    },
    "data": {
        "alert_id": "532af911b8e0dd9b47dea7fa",
        "event_id": "52e2e833e4b013563c3ea1ee",
        "channel_id": "532851a1b8e0cd4ae4050b06",
        "alert_type_id": "532af8d8b8e0dd9b47dea7f8",
        "last_alert_time": "Mar 21, 2014 03:39:30 PM UTC",
        "next_possible_alert_time_ms": 1395502770715
    }
}