Page History

...

Anchor

	addUserToTeam
	addUserToTeam

Add the user to the team

Deck of Cards

id	bimAddUserToTeam

Card

label	HTTP Method

...

Card

POST

Card

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/members

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

Example: https://api.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
status	mandatory	string	Status of the membership(Active / Passive)

Card

label	Description

...

Add a specified user to a specified team.

Card

Card

label	Request

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"
    ],
    "status": "Active"

}

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 Ok

Card

Deck of Cards

Anchor

	getMembersOfTeam
	getMembersOfTeam

Get the member list of the team

Deck of Cards

id	bimGetMemberListInfo

Card

label	HTTP Method

...

GET

Card

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/members

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

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

Card

label	Description

...

deck

Card

Gets the member list of a specified team.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

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

Card

Anchor

	updateUserInTeam
	updateUserInTeam

Update information about the user in the team

Deck of Cards

id	bimUpdateUserInfoInTeam

Card

label	HTTP Method

...

Card

PUT

Card

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/members/<user_id>

URL: https://api.bimplus.net/v2//members/

Example: https://api.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

label	Description

...

Update information about a specified user in a team.

...

Card

label	Request

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Card

Deck of Cards

Anchor

	deleteUserFromTeam
	deleteUserFromTeam

Delete the user from the team

Deck of Cards

id	bimDeleteUserFromTeam

Card

label	HTTP Method

...

Card

DELETE

Card

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/members/<user_id>

URL: https://api.bimplus.net/v2//members/

Example: https://api.bimplus.net/v2/best-company/members/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

Card

label	Description

Deletes a specified user from a team.

...

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Card

Deck of Cards

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 253

New Version 254

Key

Add the user to the team

Get the member list of the team

Update information about the user in the team

Delete the user from the team