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. When each notification is put onto the queue database, a unique id will be generated. This id will be used later for deleting the notification once forwarded. Either the X-Client-ID or the api-subscription-fields-id header must be included in the request. If the api-subscription-fields-id is supplied, 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 'X-Client-ID: pHnwo74C0y4SckQUbcoL2DbFAZ0b' \
  -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.

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 tests, integration tests, acceptance tests and code coverage reports. In order to run them, use this command line:

./run_all_tests.sh

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