Add API contract GET recruiter information

members/README.md

@@ -5,16 +5,16 @@
 Same as the [user](https://github.com/Real-Dev-Squad/website-api-contracts/tree/main/users#user-object) object
 ## Recruiter Object
 
-```
+```json
 {   
-    'company': string,
-    'first_name': string,
-    'last_name': string,
-    'designation': string,
-    'reason': string,
-    'email': string,
-    'currency': string,
-    'package': number
+    "company": "string",
+    "first_name": "string",
+    "last_name": "string",
+    "designation": "string",
+    "reason": "string",
+    "email": "string",
+    "currency": "string",
+    "package": "number"
 }
 ```
 
@@ -43,19 +43,25 @@ Returns all members in the system.
 - **Success Response:**
 - **Code:** 200
   - **Content:**
-
-```
-{
-  message: 'Members returned successfully!'
-  members: [
-           {<member_object>}
-         ]
-}
-```
+    ```json
+    {
+        "message": "Members returned successfully!",
+        "members": [
+            "<member_object>"
+        ]
+    }
+    ```
 
 - **Error Response:**
   - **Code:** 500
-    - **Content:** `{ 'statusCode': 500, 'error': 'Internal Server Error', 'message': 'Something went wrong. Please contact admin' }`
+    - **Content:** 
+      ```json
+      {
+          "statusCode": 500,
+          "error": "Internal Server Error",
+          "message": "Something went wrong. Please contact admin"
+      }
+      ```
 
 ## **GET /members/idle**
 
@@ -74,19 +80,25 @@ Returns all inactive/idle members in the system.
 - **Success Response:**
 - **Code:** 200
   - **Content:**
-
-```
-{
-  message: 'Idle members returned successfully!'
-  members: [
-           <username>
-         ]
-}
-```
+    ```json
+    {
+        "message": "Idle members returned successfully!",
+        "members": [
+            "<username>"
+        ]
+    }
+    ```
 
 - **Error Response:**
   - **Code:** 500
-    - **Content:** `{ 'statusCode': 500, 'error': 'Internal Server Error', 'message': 'Something went wrong. Please contact admin' }`
+    - **Content:** 
+      ```json
+        {
+            "statusCode": 500,
+            "error": "Internal Server Error",
+            "message": "Something went wrong. Please contact admin"
+        }
+      ```
 
 ## POST /members/intro/:username
 Creates new request for member introduction 
@@ -104,13 +116,58 @@ Creates new request for member introduction
 - **Success Response:**
     - **Code:** 200
         - **Content:** 
-        ```
-        {
-            message: 'Request Submission Successful!!'
-            id: <new unique submission id>
-        }
-        ```
+          ```json
+          {
+              "message": "Request Submission Successful!!",
+              "id": "<new unique submission id>"
+          }
+          ```
 
 - **Error Response:**
     - **Code:** 500
-        - **Content:** `{ 'statusCode': 500, 'error': 'Internal Server Error', 'message': 'An internal server error occurred' }`
+        - **Content:** 
+          ```json
+          {
+              "statusCode": 500,
+              "error": "Internal Server Error",
+              "message": "An internal server error occurred"
+          }
+          ```
+
+## **GET /members/intro/**
+
+Returns all requests for member introduction by recruiter in the system.
+
+- **Params**  
+  None
+- **Query**  
+  None
+- **Body**  
+  None
+- **Headers**  
+  None
+- **Cookie**  
+  None
+- **Success Response:**
+- **Code:** 200
+  - **Content:**
+    ```json
+    {
+        "message": "Recruiters returned successfully!",
+        "recruiters": [
+            "<recruiter_object>",
+            "<recruiter_object>"
+        ]
+    }
+    ```
+
+- **Error Response:**
+  - **Code:** 500
+    - **Content:** 
+      ```json
+      {
+          "statusCode": 500,
+          "error": "Internal Server Error",
+          "message": "Something went wrong. Please contact admin"
+      }
+      ```