Community Membership

Community Membership

Gives details

API's

Method	API	Desc
GET	/communitymembership/:domain/members	Get all members in a specified community
POST	/communitymembership/:domain/members	Add members into a community
PATCH	/communitymembership/:domain/members	Modify role of a members in a community
DELETE	/communitymembership/:domain/members	Remove members from a community

1. Get member of a specified community

URI

HTTP GET /communitymembership/:domain/members

URI Params

Required

domain[text] 

Data Params

 No Input Data

Success Response

Code : 200

Content :

           {
                    "domain" : "wipro.chnn",
             "MemberDetails" : [
                                 {
                                   "username" : "keerthana_n@gmail.com",
                                       "role" : "full-stack-developer"
                                  },
                                  {
                                    "username" : "aravindhchandran@gmail.com",
                                        "role" : "digital-developer"
                                   }
                               ]
           }

Error Response

Code      :  400 Bad Request

Content   :  { error: 'please enter a valid domain' }  

  or

Code      :  404 NOT FOUND
Content   :  { error: 'Resource not found' } 
       
  or

Code      :  505 Internal server error

Content   :  { error: 'Unexpected error occurred, please try again...! ' }

2 . Add members into community

URI

HTTP POST /communitymembership/:domain/members

URI Params

Required

domain[text] 

Data Params

Content :

           [
            {
              "username" : "keerthana_n@gmail.com",
              "role"     : "Admin"
            },
            {
              "username" : "aravindhchandran@gmail.com",
               "role"     : "Moderator"
             }
           ]

Success Response

Code : 200

Content: { message: 'Member added' }

Error Response

Code      :  400 BAD REQUEST

Content   :  { error: 'Body data cannot be empty' } 
        
  or

Code      :  400 BAD REQUEST

Content   :  { error: 'Value of username and role cannot be empty' } 
        
  or

Code      :  400 BAD REQUEST

Content   :  { error: 'Specified role is not available for this community' } 
        
  or

Code      :  400 BAD REQUEST

Content   :  { error: 'Member detail already exist' }  
       
  or

Code      :  404 NOT FOUND
Content   :  { error: 'Resource not found' }   
      
  or

Code      :  505 Internal server error

Content   :  { error: 'Unexpected error occurred, please try again...! ' }

3. Modify member role in specified community

URI

HTTP PATCH /communitymembership/:domain/members

URI Params

Required

domain[text] 

Data Params

Content :

           [
            {
              "username" : "keerthana_n@gmail.com",
              "role"     : "Admin"
            },
            {
              "username" : "aravindhchandran@gmail.com",
               "role"     : "Moderator"
             }
           ]

Success Response

Code    : 200

Content : { message: 'Role modified' }

Error Response

Code      :  400 BAD REQUEST

Content   :  { error: 'Body data cannot be empty' } 
        
  or

Code      :  400 BAD REQUEST

Content   :  { error: 'Value of username and role cannot be empty' } 
        
  or

Code      :  400 BAD REQUEST

Content   :  { error: 'Specified role is not available for this community' } 
        
  or

Code      :  400 BAD REQUEST

Content   :  { error: 'Member details not available' }  
       
  or

Code      :  404 NOT FOUND

Content   :  { error: 'Resource not found' }   
      
  or

Code      :  505 Internal server error
Content   :  { error: 'Unexpected error occurred, please try again...! ' }

4. Remove member from a specified community

URI

 HTTP DELETE /communitymembership/:domain/members

URI Params

Required

domain[text] 

Data Params

Content :

           [
            {
              "username" : "keerthana_n@gmail.com"
            },
            {
              "username" : "aravindhchandran@gmail.com"
             }
           ]

Success Response

Code : 200

Content: { message: 'Member deleted' }

Error Response

Code      :  400 BAD REQUEST

Content   :  { error: 'Body data cannot be empty' } 
        
  or

Code      :  400 BAD REQUEST

Content   :  { error: 'Value of username cannot be empty' } 
        
  or

Code      :  400 BAD REQUEST

Content   :  { error: 'Member details not available' } 
       
  or

Code      :  404 NOT FOUND

Content   :  { error: 'Resource not found' }   
      
  or

Code      :  505 Internal server error
Content   :  { error: 'Unexpected error occurred, please try again...! ' }