Skip to content

SteveCN7/api-notification-pull

 
 

Repository files navigation

Pull Notifications API

Build Status Download

Introduction

This API allows third party developers to collect notifications.


Endpoints

DELETE /{notificationId}

Retrieves and deletes a notification from api-notification-queue

Required Headers:

  • X-Client-ID
  • Accept
curl -v -X DELETE "https://localhost:9649/{notificationId}" \
  -H "X-Client-ID: pHnwo74C0y4SckQUbcoL2DbFAZ0b" \
  -H "Accept: application/vnd.hmrc.1.0+xml"

Responses

Success
200 OK

Notification
Not Found

404 Not Found

GET /

Retrieves all notifications, for a specific client id, from api-notification-queue

Required Headers:

  • X-Client-ID
  • Accept
curl -v -X GET "https://localhost:9649/" \
  -H "X-Client-ID: pHnwo74C0y4SckQUbcoL2DbFAZ0b" \
  -H "Accept: application/vnd.hmrc.1.0+xml"

Response

200 OK

<resource href="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/notifications/">
   <link rel="self" href="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/notifications/"/>
   <link rel="notification" href="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/notifications/7ab99957-b138-4f09-888e-ab4e8107bbe0"/>
</resource>

Tests

There are unit tests, integration tests and code coverage reports. In order to run them, use this command line:

./run_all_tests.sh

License

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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Scala 96.3%
  • RAML 3.6%
  • Shell 0.1%