Membership Management Service
- Add the user to the team
- Get the member list of the team
- Update user's membership in the team
- Remove user from the team
Membership Management Service
Please remember that the team owner cannot remove the membership from his own team.
Add the user to the team
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) |
role |
optional |
string |
Team role of the user (Member / Admin / Owner / Guest), default is Member |
member_status |
optional |
string |
Status of the membership (Active / Passive), default is Active |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"user": {
"id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6"
},
"member_status": "Active"
"role": "Member"
}
Status: 200 Ok
{
"user": {
"id": "3d676814-cf37-aa43-ed03-4b156c282fa1",
"email": "testuser@allplan.com",
"status": "Active",
"firstname": "Test",
"lastname": "User",
"company": "Allplan",
"fullname": "Test User",
"displayname": "Test User [Allplan]",
"info": null,
"gender": "MR",
"phoneWork": null,
"phoneHome": null,
"fax": null,
"mobile": "123",
"birthDate": null,
"address": {
"street": "",
"streetNr": "",
"zip": "",
"city": "",
"country": ""
},
"preferedLanguage": "en"
},
"role": "Member",
"member_status": "Active"
}
Get the member list of the team
URL: https://api-stage.bimplus.net/v2/<team_slug>/members
Example: https://api-stage.bimplus.net/v2/best-company/members
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"user": {
"id": "3d676814-cf37-aa43-ed03-4b156c282fa1",
"email": "testuser@allplan.com",
"status": "Active",
"firstname": "Test",
"lastname": "User",
"company": "Allplan",
"fullname": "Test User",
"displayname": "Test User [Allplan]",
"info": null,
"gender": "MR",
"phoneWork": null,
"phoneHome": null,
"fax": null,
"mobile": "123",
"birthDate": null,
"address": {
"street": "",
"streetNr": "",
"zip": "",
"city": "",
"country": ""
},
"preferedLanguage": "en"
},
"role": "Member",
"member_status": "Active"
},
{
"user": {
"id": "0d545b40-9258-42f2-8e0e-e2325a8eb446",
"email": "testuser2@allplan.com",
"status": "Active",
"firstname": "Test",
"lastname": "User2",
"company": "Allplan",
"fullname": "Test User2",
"displayname": "Test User2 [Allplan]",
"info": null,
"gender": "MR",
"phoneWork": null,
"phoneHome": null,
"fax": null,
"mobile": "123",
"birthDate": null,
"address": {
"street": "",
"streetNr": "",
"zip": "",
"city": "",
"country": ""
},
"preferedLanguage": "de"
},
"role": "Member",
"member_status": "Active"
}
]
Update user's membership in the team
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 |
member_status |
mandatory |
string |
Status of the membership(Active / Passive) |
role |
optional |
string |
Team role of the user (Guest /Member / Admin / Owner ), default is Member |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"user": {
"id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c7"
},
"role": "Admin"
"member_status": "Active"
}
Status: 200 OK
Remove user from the team
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
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
