View Source

Membership Management Service

Please remember that the team owner cannot remove the membership from his own team.

Add the user to the team

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)

POST

Add a specified user to a specified team.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{
    "user": {
        "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6"
    },
    "roles": [
        "Member"
    ],
    "member_status": "Active"

}

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"
    },
    "roles": [
      "Member"
    ],
    "member_status": "Active"
  }

Get the member list of the team

Resource: <team_slug>/members

URL: https://api-stage.bimplus.net/v2/<team_slug>/members

Example: https://api-stage.bimplus.net/v2/best-company/members

GET

Gets the member list of a specified team.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

[
    {
        "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"
    }
]

Update information about the user in the team

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)

PUT

Update information about a specified user in a team.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{
        "user": {
            "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c7"
        },
        "status": "Active"
    }

Status: 200 OK

Delete the user from the team

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

DELETE

Deletes a specified user from a team.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK