openemp-api-notification

OpenEMP Notification Service API

Setup

Requirements

• git
• node v4+.X.X (used v11.14.0)
• mongodb v2.6+ (used v4.2.7)

Build

To build the notification API run the following:

git clone https://github.com/openemp/openemp-api-notification
cd openemp-api-notification
npm i

Make .env file and use the .env.example as guide.

Start

To start the server run either npm run start or npm run dev (nodemon watch).

Services

Store notification:

• Description: Send a notification to a list of profiles
• URL: /api/v1/notifications Method: POST
• Bearer Token that hold the senderID
• Body:

{
  "uuid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "content": "some content",
  "receiver": "2",
  "read": false,
  "retired": false
}

• Response:

201 - notifications sent
400 - invalid input, object invalid

Get notifications:

• Description: By passing a JWT and profile ID you can get a list of notifications, by passing in the appropriate options, you can search for available inventory in the system
• URL: /api/v1/notifications Method: GET
• Bearer Token that hold the receiverID
• Params:

read - set to true to also include seen notifications

• Response:

200 - search results matching criteria
400 - bad input parameter