From 29fca89e63a37bd7662b8a98c3cb346c59a2079d Mon Sep 17 00:00:00 2001 From: Shubham Date: Sat, 8 Jan 2022 08:58:55 +0530 Subject: [PATCH] Add GET members intro API contract --- members/README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/members/README.md b/members/README.md index 238689f..63215f9 100644 --- a/members/README.md +++ b/members/README.md @@ -133,3 +133,41 @@ Creates new request for member introduction "message": "An internal server error occurred" } ``` + +## **GET /members/intro/** + +Returns all requests for member introduction by recruiter in the system. + +- **Params** + None +- **Query** + type=[ all | new | blocked ] +- **Body** + None +- **Headers** + None +- **Cookie** + None +- **Success Response:** +- **Code:** 200 + - **Content:** + ```json + { + "message": "Recruiters returned successfully!", + "recruiters": [ + "", + "" + ] + } + ``` + +- **Error Response:** + - **Code:** 500 + - **Content:** + ```json + { + "statusCode": 500, + "error": "Internal Server Error", + "message": "Something went wrong. Please contact admin" + } + ``` \ No newline at end of file