Typical scenario when using the API to create a notification¶
Create a new notification¶
- POST /notifications¶
Request:
POST /notifications HTTP/1.1 Host: api.ox.ac.uk X-Moxie-Key: d51459b5-d634-48f7-a77c-d87c77af37f1 X-HMAC-Nonce: 12642 Date: Fri, 10 Jan 2014 11:49:55 GMT Authorization: ccd61eddf0c6be849b13e524c171e4c14a0d571f Content-Type: application/json { "message": "Bomb threat at X", "expires": "2013-11-08T16:00:00", }
Response:
HTTP/1.1 201 Created Location: /notifications/16d4a94fc58111a323437ec363d71f5a
(Optionally) push the notification to registered devices¶
- POST /push¶
Request:
POST /push HTTP/1.1 Host: api.ox.ac.uk X-Moxie-Key: d51459b5-d634-48f7-a77c-d87c77af37f1 X-HMAC-Nonce: 12642 Date: Fri, 10 Jan 2014 11:49:55 GMT Authorization: ccd61eddf0c6be849b13e524c171e4c14a0d571f Content-Type: application/json { "notification": "16d4a94fc58111a323437ec363d71f5a", "message": "Bomb threat at X, avoid the area" }
Response:
HTTP/1.1 202 Accepted
Add a follow up¶
- POST /notifications/16d4a94fc58111a323437ec363d71f5a/followup¶
Request:
POST /notifications/16d4a94fc58111a323437ec363d71f5a/followup HTTP/1.1 Host: api.ox.ac.uk X-Moxie-Key: d51459b5-d634-48f7-a77c-d87c77af37f1 X-HMAC-Nonce: 12642 Date: Fri, 10 Jan 2014 11:49:55 GMT Authorization: ccd61eddf0c6be849b13e524c171e4c14a0d571f Content-Type: application/json { "message": "security services have arrived on scene", }
Example response:
HTTP/1.1 201 Created Location: /notifications/16d4a94fc58111a323437ec363d71f5a/followup/1
Update the notification to be displayed until the end of the day¶
- POST /notifications/16d4a94fc58111a323437ec363d71f5a¶
Request:
POST /notifications/16d4a94fc58111a323437ec363d71f5a HTTP/1.1 Host: api.ox.ac.uk X-Moxie-Key: d51459b5-d634-48f7-a77c-d87c77af37f1 X-HMAC-Nonce: 12642 Date: Fri, 10 Jan 2014 11:49:55 GMT Authorization: ccd61eddf0c6be849b13e524c171e4c14a0d571f Content-Type: application/json { "expires": "2013-02-08T18:00:00" }
Response:
HTTP/1.1 200 OK Location: /notifications/16d4a94fc58111a323437ec363d71f5a