Versions Compared

Old Version 328

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 329

changes.mady.by.user Jayaraj Purushothaman

Saved on

Key

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

...

Section
Column
width20%

Authorization Service

Column
width20%

User Management Service

Column
width20%

Team Management Service

Column
width20%

Membership Management Service

Column
width20%

Rights & Roles Service

Section
Column
width25%

Messaging Service

Column
width25%

Log Service

Column
width50%

 

...

Deck of Cards
idbimGetMembersWithRoles
Card
labelHTTP Method
 GET
Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: projects/<project_id>/members 

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

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

Card
labelDescription
 Get the member list of a project along with their respective project roles.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
[
    {
        "member": {
            "id": "7aa846f2-6014-f68d-8dd4-4c7941d7cbcc",
            "email": "customer1@bimplus.net"
        },
        "role": {
            "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
            "name": "Project_Editor"
        }
    },
    {
        "member": {
            "id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
            "email": "customer2@bimplus.net"
        },
        "role": {
            "id": "e11d32e2-30b7-4f81-8a74-2165ecc00cf6",
            "name": "Project_Viewer"
        }
    }
]

Anchor
updateProjectRole
updateProjectRole

Update the project role of a team member
Deck of Cards
idbimUpdateProject
Card
labelHTTP Method
 PUT
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: projects/<project_id>/members 

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

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

JSON Structure: 

Name

Mandatory / Optional

Type

Description

member

mandatory

object

The member who will be assigned a role to the project

id

mandatory

string (guid)

Id of the user

role

mandatory

object

The project role which will be assigned to the team member

id

mandatory

string (guid)

Id of the role

Card
labelDescription
 Update the project role of a team member. Only the user with "Account Owner" or "Project Owner" role can use this API call.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
  "member": {
    "id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
    "email": "customer@bimplus.net"
  },
  "role": {
    "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
    "name": "Project_Viewer"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

Anchor
deleteProjectRole
deleteProjectRole

Remove the user from the project   
Deck of Cards
idbimdeleteProjectRole
Card
labelHTTP Method
 DELETE
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: projects/<project_id>/members 

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

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

Card
labelDescription
 Remove the user from a project
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
messagingService
messagingService

...