Page History

...

Deck of Cards

id	bimAddUserToTeam

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)
role	optional	objectstring	Team role of the user (Member / Admin / Owner ), default is Member
member_status	optional	string	Status of the membership (Active / Passive)

Card

label	HTTP Method

POST

Card

label	Description

Add a specified user to a specified team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 Ok

Code Block

title	JSON

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

...

Deck of Cards

id	bimGetMemberListInfo

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

Card

label	HTTP Method

GET

Card

label	Description

Gets the member list of a specified team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

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

...

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
member_status	mandatory	string	Status of the membership(Active / Passive)
role	optional	string	Team role of the user (Member / Admin / Owner ), default is Member

Card

label	HTTP Method

PUT

Card

label	Description

Update user's membership in the team by changing his status

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 6

New Version 7

Key