Page History

...

Deck of Cards

id	bimGetAllRoles

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/roles

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

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

Card

label	Description

Get all the available. Right now, we support only project based roles.

Here is the definition of Bimplus Rights & Roles.

	Account Owner	Project Admin	Project Editor	Project Viewer	Model Admin	Model Editor	Model Viewer
Create Project	x	x
Admin Project (eg. invite)	x	x
Edit Project	x	x	x
Delete Project	x	x
View Project	x	x	x	x	x	x	x

View all Models	x	x	x	x
Create Model	x	x	x
Admin Model (eg. invite)	x	x
Assign User to Model	x	x	x		x
Edit Model	x	x	x		x	x
Import Data	x	x	x		x	x
Delete Model	x	x	x		x
View Model	x	x	x	x	x	x	x

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

[
    {
        "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
        "name": "Project_Editor",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_Edit",
                    "Project_View",
                    "Model_ViewAll"
                ]
            }
        ]
    },
    {
        "id": "2baca0e4-2eee-4f7c-bc56-22ed54a1859c",
        "name": "Account_Owner",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightGlobal",
                "rights": [
                    "AllProjects",
                    "AllModels",
                    "Project_Create"
                ]
            }
        ]
    },
    {
        "id": "a298b28d-9711-4a76-9a7d-910cbf144ee5",
        "name": "Project_Admin",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_Admin",
                    "Project_Edit",
                    "Project_Delete",
                    "Project_View",
                    "Model_ViewAll",
                    "Model_Create"
                ]
            }
        ]
    },
    {
        "id": "a618d075-7e4a-4bde-9d58-d2979696fa96",
        "name": "Project_Viewer",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_View",
                    "Model_ViewAll"
                ]
            }
        ]
    }
]

Anchor

	createMessage
	createMessage

Make a team member part of a project by assigning a role to him

Deck of Cards

id	bimCreateMessage

Card

label	HTTP Method

POST

Card

default	true
label	URL / 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

label	Description

Create a new message for an user.

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

{
    "id": "4633d522-53aa-4d81-90b4-704681e0573d",
    "userid": "c7040e44-508a-4d10-88dc-b7c7ace6c650",
    "source": "ServiceName",
    "topic": "SKETCHUP_JOB",
    "severity": "Warn",
    "returncode": "FILE_TOO_BIG",
    "unread": false,
    "timestamp": "2013-11-15T10:55:53"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Anchor

	messagingService
	messagingService

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 324

New Version 325

Key

Make a team member part of a project by assigning a role to him