Skip to content
This repository has been archived by the owner on Jun 14, 2023. It is now read-only.

Latest commit

 

History

History
 
 

members

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 

Members

Member object

Same as the user object

Recruiter Object

{   
    'company': string,
    'first_name': string,
    'last_name': string,
    'designation': string,
    'reason': string,
    'email': string,
    'currency': string,
    'package': number
}

Requests

Route Description
GET /members Returns all members in the system
GET /members/idle Returns all inactive/idle members in the system
POST /members/intro/:username Post request for members profile introduction

GET /members

Returns all members in the system.

  • Params
    None
  • Query
    type=[ all | new | blocked ]
  • Body
    None
  • Headers
    None
  • Cookie
    None
  • Success Response:
  • Code: 200
    • Content:
{
  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' }

GET /members/idle

Returns all inactive/idle members in the system.

  • Params
    None
  • Query
    None
  • Body
    None
  • Headers
    None
  • Cookie
    None
  • Success Response:
  • Code: 200
    • Content:
{
  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' }

POST /members/intro/:username

Creates new request for member introduction

  • Params
    Required: username=[string]

  • Query
    None

  • Body
    {<recruiter_object>}

  • Headers
    None

  • Cookie
    None

  • Success Response:

    • Code: 200
      • Content:
      {
          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' }