Merge pull request #165 from Real-Dev-Squad/api-contract/notify

Api contract/notify

Author: iamitprakash

fcm-token/README.md

@@ -0,0 +1,95 @@
+# Collection - fcmTokens
+
+## API Endpoints
+
+|                Route                |                    Description                     |
+| :---------------------------------: | :------------------------------------------------: |
+| [POST /v1/fcm-tokens](#post-notify) | Saves FCM token to uniquely identified the device. |
+|                                     |
+
+## POST /v1/fcm-tokens
+
+    Creates a new fcm-token document.
+
+- **Params**  
+  None
+- **Query**
+  None
+- **Body**
+
+  - Attributes
+    - **fcmToken** (required, string): Specifies the fcm token for the document which will uniquely identified the device.
+
+- **Headers**
+  - Content-Type: application/json
+- **Cookie**
+  None
+- **Success Response:**
+
+  - **Code:** 201
+
+    - **Content:**
+
+      ```json
+      {
+        "status": 201,
+        "message": "Device registered successfully"
+      }
+      ```
+
+- **Error Response:**
+
+  - **Code:** 400
+
+    - **Content:**
+
+      ```json
+      {
+        "statusCode": 400,
+        "error": "Bad Request",
+        "message": "\"fcmToken\" is required"
+      }
+      ```
+
+  - **Code:** 409
+
+    - **Content:**
+
+      ```json
+      {
+        "status": 409,
+        "message": "Device Already Registered"
+      }
+      ```
+
+  - **Code:** 500
+
+    - **Content:**
+
+      ```json
+      {
+        "message": "The server has encountered an unexpected error. Please contact the administrator for more information."
+      }
+      ```
+
+- **Example for device fcm-token document creation request:**
+  POST /v1/fcm-tokens<br/>
+  Content-Type: application/json<br/>
+  Request-Body:<br/>
+
+  ```json
+  {
+    "fcmToken": "jkshdsadlksajdl"
+  }
+  ```
+
+  Response :
+  Status 201<br/>
+  Content-Type: application/json<br/>
+
+  ```json
+  {
+    "status": 201,
+    "message": "Device registered successfully"
+  }
+  ```

notify/README.md

@@ -0,0 +1,114 @@
+# Collection - no collection for now
+
+## API Endpoints
+
+|                     Route                     |                  Description                  |
+| :-------------------------------------------: | :-------------------------------------------: |
+| [POST /v1/notifications](#post-notifications) | send notification to your specified fcm token |
+|                                               |
+
+## POST /v1/notifications
+
+    Send notification to your specified device.
+
+- **Params**  
+  None
+- **Query**
+  None
+- **Body**
+
+  - Attributes
+    - **title** (required, string): notification title
+    - **body** (required, string): notification message
+    - **userId** (optional, string): user who is assigning
+    - **groupRoleId** (optional, string) : group to whom the notification will be broadcasted
+
+- **Headers**
+  - Content-Type: application/json
+- **Cookie**
+  None
+- **Success Response:**
+  - **Code:** 200
+    - **Content:**
+      ```json
+      {
+        "status": 200,
+        "message": "User notified successfully"
+      }
+      ```
+- **Error Response:**
+
+  - **Code:** 400
+
+    - **Content:**
+
+      ```json
+      {
+        "statusCode": 400,
+        "error": "Bad Request",
+        "message": "\"value\" must contain at least one of [userId, groupRoleId]"
+      }
+      ```
+
+      - **Code:** 401
+
+    - **Content:**
+      ```json
+      {
+        "statusCode": 406,
+        "error": "Bad Request",
+        "message": "Message length exceeds"
+      }
+      ```
+
+  - **Code:** 500
+    - **Content:**
+      ```json
+      {
+        "statusCode": 500,
+        "message": "The server has encountered an unexpected error. Please contact the administrator for more information."
+      }
+      ```
+
+- **Example for device fcm-token document creation request:**
+  POST /v1/notifications<br/>
+  Content-Type: application/json<br/>
+  Request-Body:<br/>
+
+  ```json
+  {
+    "title": "testing",
+    "body": "Helloo world",
+    "userId": "feJ49TjqHVG4O0luUDlz"
+  }
+  ```
+
+  Response :
+  Status 200<br/>
+  Content-Type: application/json<br/>
+
+  ```json
+  {
+    "status": 200,
+    "message": "User notified successfully"
+  }
+  ```
+
+  ```json
+  {
+    "title": "testing",
+    "body": "Helloo world",
+    "groupRoleId": "1147354535342383104"
+  }
+  ```
+
+  Response :
+  Status 200<br/>
+  Content-Type: application/json<br/>
+
+  ```json
+  {
+    "status": 200,
+    "message": "User notified successfully"
+  }
+  ```