Endpoint¶

Format¶

Dates are expressed as YYYY-mm-DDTHH:mm:ss (e.g. 2013-11-08T16:00:00)

Methods¶

Endpoint to create and retrieve notifications

Warning

All the routes below refer to the root of the module. The identifier of the module should be concatenated (e.g. route / should be concatenated with the name of the module, /notifications).

POST /¶

Create a new notification

Requires authentication

Example request:

POST /notifications HTTP/1.1
Host: api.m.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",
}

Example response:

HTTP/1.1 201 Created
Location: /notifications/774aaaa5-d45b-4687-b7fb-d59aae606eb9

{
  "ident": "774aaaa5-d45b-4687-b7fb-d59aae606eb9",
  "status": "created"
}

Json Parameters:

message (string) – the message of the notification
timestamp (date) – (optional) start date of the notification (defaults to current time)
expires (date) – (optional) end date of the notification (defaults to one hour after current time)
url (string) – (optional) url describing the notification
label (string) – (optional) label describing the notification

Status Codes:

201 – 201 Created: notification created
400 – 400 Bad Request
401 – 401 Unauthorized

POST /push¶

Request a notification to be pushed to registered devices

Requires authentication

Example request:

POST /push HTTP/1.1
Host: api.m.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": "{uuid}",
    "message": "Bomb threat at X, avoid the area"
}

Example response:

HTTP/1.1 202 Accepted

Json Parameters:
	notification (string) – unique identifier of the notification message (string) – message of the push notification
Status Codes:	202 – 202 Accepted: push request queued 400 – 400 Bad Request 401 – 401 Unauthorized

POST /(string: uuid)¶

Update a notification

Requires authentication

Example request:

POST /notifications/X HTTP/1.1
Host: api.m.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, avoid the area!",
}

Example response:

HTTP/1.1 200 OK
Location: /notifications/{uuid}

Json Parameters:
Parameters:	uuid (string) – unique identifier of the notification
	message (string) – the message of the notification timestamp (date) – (optional) start date of the notification expires (date) – (optional) end date of the notification url (string) – (optional) url describing the notification label (string) – (optional) label describing the notification
Status Codes:	200 – 200 OK: update applied correctly 400 – 400 Bad Request 401 – 401 Unauthorized 404 – 404 Not Found: notification not found

POST /(string: uuid)/followup¶

Add a follow up to an existing notification

Requires authentication

Example request:

POST /notifications/X/followup HTTP/1.1
Host: api.m.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/X/followup/1

Json Parameters:
Parameters:	uuid (string) – unique identifier of the notification
	message (string) – the message of the follow up timestamp (date) – (optional) date of the follow up
Status Codes:	201 – 201 Created: followup created 400 – 400 Bad Request 401 – 401 Unauthorized 404 – 404 Not Found: notification not found

POST /(string: uuid)/followup/(string: id)¶

Update a follow up

Requires authentication

Example request:

POST /notifications/X/followup/1 HTTP/1.1
Host: api.m.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": "Fire department working",
}

Example response:

HTTP/1.1 200 OK
Location: /notifications/{uuid}/followup/1

Json Parameters:
Parameters:	uuid (string) – unique identifier of the notification id (string) – identifier of the followup
	message (string) – the message of the follow up timestamp (date) – (optional) date of the follow up
Status Codes:	200 – 200 OK: update applied correctly 400 – 400 Bad Request 401 – 401 Unauthorized 404 – 404 Not Found: notification not found or followup not found

DELETE /(string: uuid)¶

Delete a notification

Requires authentication

Example request:

DELETE /notifications/X HTTP/1.1
Host: api.m.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

Example response:

HTTP/1.1 200 OK

Parameters:	uuid (string) – unique identifier of the notification
Status Codes:	200 – 200 OK: notification deleted 401 – 401 Unauthorized 404 – 404 Not Found: notification not found

DELETE /(string: uuid)/followup/(string: id)¶

Delete a follow up

Requires authentication

Example request:

DELETE /notifications/X/followup/1 HTTP/1.1
Host: api.m.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

Example response:

HTTP/1.1 200 OK

Parameters:	uuid (string) – unique identifier of the notification id (string) – identifier of the follow up
Status Codes:	200 – 200 OK: follow up deleted 401 – 401 Unauthorized 404 – 404 Not Found: notification not found or follow up not found

GET /¶

Get ongoing notifications

Example request:

GET /notifications HTTP/1.1
Host: api.m.ox.ac.uk
Accept: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "notifications": [
        {
            "uuid": "X",
            "timestamp": "2013-02-08T12:30",
            "message": "Bomb threat at X",
            "expires": "2013-02-08:16:00",
            "followups": [
                {
                    "timestamp": "2013-02-08T13:30",
                    "id": 1,
                    "message": "bla bla"
                },
                ...
            ]
        }
    ]
}

Query Parameters:
	history – boolean value (“true”, “True”, “1”, “t”) to display all notifications (defaults to false)
Status Codes:	200 – 200 OK

GET /(string: uuid)¶

Get a notification

Example request:

GET /notifications/X HTTP/1.1
Host: api.m.ox.ac.uk
Accept: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "uuid": "X",
    "timestamp": "2013-02-08T12:30",
    "message": "Bomb threat at X,
    "expires": "2013-02-08:16:00",
    "followups": [
        {
            "timestamp": "2013-02-08T13:30",
            "id": 1,
            "message": "bla bla"
        },
        ...
    ]
}

Status Codes:	200 – 200 OK 404 – 404 Not Found: notification not found