This service provides a means to persist and retrieve notifications. The upstream client is the api-notification-pull service.

Payload must be text based, e.g. XML. If a notification-id header is supplied then this is used as the notification ID otherwise it is generated when each notification is saved. This id will be used for retrieving the notification. The api-subscription-fields-id header must be included in the request. The client ID will be retrieved from the api-subscription-fields service.

curl -v -X POST \
  http://localhost:9648/queue \
  -H 'Accept: application/xml' \
  -H 'Content-Type: application/xml' \
  -H 'api-subscription-fields-id: d2a985e9-dbef-4bb6-bd8d-4e9e9594473f' \
  -d '<xml>foo</xml>'

201 Created status and the Location header will contain the URL, e.g. /notification/ba544f92-b2dd-413e-becf-874b35eb3724.

Retrieves a specific notification.

Required header: X-Client-ID.

curl -v -X GET "http://localhost:9648/notification/ba544f92-b2dd-413e-becf-874b35eb3724" \
  -H "X-Client-ID: pHnwo74C0y4SckQUbcoL2DbFAZ0b"

200 OK code on successful get, otherwise 404 Not Found. Note that all headers in the above POST are replayed in the response with the exception of X-Client-ID.

Retrieves a specific notification and sets datePulled field in MongoDB.

Required header: X-Client-ID.

curl -v -X GET "http://localhost:9648/notifications/unpulled/ba544f92-b2dd-413e-becf-874b35eb3724" \
  -H "X-Client-ID: pHnwo74C0y4SckQUbcoL2DbFAZ0b"

200 OK code on successful get, otherwise 404 Not Found.

Retrieves a specific, previously pulled notification.

Required header: X-Client-ID.

curl -v -X GET "http://localhost:9648/notifications/pulled/ba544f92-b2dd-413e-becf-874b35eb3724" \
  -H "X-Client-ID: pHnwo74C0y4SckQUbcoL2DbFAZ0b"

200 OK code on successful get, otherwise 404 Not Found.

Retrieves a list of unpulled notifications.

Required header: X-Client-ID.

curl -v -X GET "http://localhost:9648/notifications/unpulled" \
  -H "X-Client-ID: pHnwo74C0y4SckQUbcoL2DbFAZ0b"

200 OK code on successful get, otherwise an empty list.

Retrieves a list of previously pulled notifications.

Required header: X-Client-ID.

curl -v -X GET "http://localhost:9648/notifications/pulled" \
  -H "X-Client-ID: pHnwo74C0y4SckQUbcoL2DbFAZ0b"

200 OK code on successful get, otherwise an empty list.

Retrieves a list of notifications with the supplied conversationId. Both pulled and unpulled are returned.

Required header: X-Client-ID.

curl -v -X GET "http://localhost:9648/notifications/conversationId/e83ad4fc-16a3-4ff9-92d4-87fa468ee733" \
  -H "X-Client-ID: pHnwo74C0y4SckQUbcoL2DbFAZ0b"

200 OK code on successful get with sample body below, otherwise an empty list.

{
    "notifications": [
        "/notifications/pulled/b6c00206-3b90-455e-918e-45af23c0e21d"
        "/notifications/pulled/c2be30be-24e3-4965-bc6a-2948ede37362"
        "/notifications/unpulled/bb7a3662-958a-4905-acb6-c724d5c1c5b3"
    ]
}

Retrieves a list of pulled notifications with the supplied conversationId.

Required header: X-Client-ID.

curl -v -X GET "http://localhost:9648/notifications/conversationId/e83ad4fc-16a3-4ff9-92d4-87fa468ee733"/pulled \
  -H "X-Client-ID: pHnwo74C0y4SckQUbcoL2DbFAZ0b"

200 OK code on successful get with sample body below, otherwise an empty list.

{
    "notifications": [
        "/notifications/pulled/b6c00206-3b90-455e-918e-45af23c0e21d"
        "/notifications/pulled/c2be30be-24e3-4965-bc6a-2948ede37362"
    ]
}

Retrieves a list of unpulled notifications with the supplied conversationId.

Required header: X-Client-ID.

curl -v -X GET "http://localhost:9648/notifications/conversationId/e83ad4fc-16a3-4ff9-92d4-87fa468ee733"/unpulled \
  -H "X-Client-ID: pHnwo74C0y4SckQUbcoL2DbFAZ0b"

200 OK code on successful get with sample body below, otherwise an empty list.

{
    "notifications": [
        "/notifications/unpulled/b6c00206-3b90-455e-918e-45af23c0e21d"
        "/notifications/unpulled/c2be30be-24e3-4965-bc6a-2948ede37362"
    ]
}

Gets all notifications of a specific third-party application.

Required header: X-Client-ID.

curl -v -X GET "http://localhost:9648/notifications" \
  -H "X-Client-ID: pHnwo74C0y4SckQUbcoL2DbFAZ0b"

200 OK code.

Deletes a specific notification.

Required header: X-Client-ID.

curl -v -X DELETE "http://localhost:9648/notification/ba544f92-b2dd-413e-becf-874b35eb3724" \
  -H "X-Client-ID: pHnwo74C0y4SckQUbcoL2DbFAZ0b"   

204 No Content on successful delete, otherwise 404 Not Found.

Some tests require MongoDB to run. Thus, remember to start up MongoDB if you want to run the tests locally. There are unit, integration and component tests along with code coverage reports. In order to run them, use this command line:

./precheck.sh

A warning email is sent when the scheduler finds notifications per clientId in the database that exceed a configurable (notification.email.queueThreshold) threshold. The email is currently configured (notification.email.interval) to send one per day. The to address is configured with notification.email.address.

This code is open source software licensed under the Apache 2.0 License