Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Deck of Cards
idbimDeleteUserFromTeam
Card
labelHTTP Method
 DELETE
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: <team_slug>/members/<user_id> 

URLhttps://api.bimplus.net/v2//members/

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

Card
labelDescription
Deletes a specified user from a team. 
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

Anchor
rightsRolesService
rightsRolesService

Rights & Roles Service

...

Anchor
addUserToTeam
addUserToTeam

Add the user to the team
Deck of Cards
idbimAddUserToTeam
Card
labelHTTP Method
 POST
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: <team_slug>/members 

URLhttps://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

member_status

optional

string

Status of the membership(Active / Passive)

Card
labelDescription
 Add a specified user to a specified team.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "user": {
        "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6"
    },
    "roles": [
        "Member"
    ],
    "member_status": "Active"

}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 Ok

Anchor
messagingService
messagingService

...