Membership Management Service
...
Membership Management Service
...
| Anchor |
|---|
| addUserToTeam |
|---|
| addUserToTeam |
|---|
|
Please remember that the team owner cannot remove the membership from his own team.
Add the user to the team
| Deck of Cards |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| | Resource: <team_slug>/members URL: https://api-stage.bimplus.net/v2/<team_slug>/members Example: https://api-stage.bimplus.net/v2/best-company/members JSON Structure: Name | Mandatory / Optional | Type | Description |
|---|
user | mandatory | object | Information of the user | user.id | mandatory | string | Id of the user | user.email | will be ignored | string | Email of the user | user.status | will be ignored | string | Status of the user(Active / Inactive) | roles | will be ignored | object | Roles of the user | member_status | optional | string | Status of the membership(Active / Passive) |
|
| Card |
|---|
| | Add a specified user to a specified team. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Headers |
|---|
| lang | xml |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block |
|---|
| borderColor | Red |
|---|
| title | JSON |
|---|
| lang | xml |
|---|
| {
"user": {
"id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6"
},
"roles": [
"Member"
],
"member_status": "Active"
}
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Status |
|---|
| lang | xml |
|---|
| Status: 200 Ok
|
|
|
| Anchor |
|---|
| getMembersOfTeam |
|---|
| getMembersOfTeam |
|---|
|
Get the member list of the team
| Deck of Cards |
|---|
|
| Card |
|---|
| | Gets the member list of a specified team. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Headers |
|---|
| lang | xml |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Status |
|---|
| lang | xml |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| borderColor | Red |
|---|
| title | JSON |
|---|
| lang | xml |
|---|
| [
{
"user": {
"id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
"email": "test@bimplus.net",
"status": "Active"
},
"roles": [
"Member"
],
"status": "Active"
},
{
"user": {
"id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c7",
"email": "customer@bimplus.net",
"status": "Active"
},
"roles": [
"Member"
],
"status": "Passive"
}
]
|
|
|
| Anchor |
|---|
| updateUserInTeam |
|---|
| updateUserInTeam |
|---|
|
| Deck of Cards |
|---|
| id | bimUpdateUserInfoInTeam |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| | Resource: <team_slug>/members/<user_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/members/<user_id> Example: https://api-stage.bimplus.net/v2/best-company>/members/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6 JSON Structure: Name | Mandatory / Optional | Type | Description |
|---|
user | mandatory | object | Information of the user | user.id | mandatory | string | Id of the user | status | mandatory | string | Status of the membership(Active / Passive) |
|
| Card |
|---|
| | Update information about a specified user in a team. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Headers |
|---|
| lang | xml |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block |
|---|
| borderColor | Red |
|---|
| title | JSON |
|---|
| lang | xml |
|---|
| {
"user": {
"id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c7"
},
"status": "Active"
}
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Status |
|---|
| lang | xml |
|---|
| Status: 200 OK
|
|
|
| Anchor |
|---|
| deleteUserFromTeam |
|---|
| deleteUserFromTeam |
|---|
|
Delete the user from the team
| Deck of Cards |
|---|
|
| Card |
|---|
| | Deletes a specified user from a team. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Headers |
|---|
| lang | xml |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Status |
|---|
| lang | xml |
|---|
| Status: 200 OK
|
|
|