View Source

Team Management Service

Please remember that creating/updating/deleting a team is possible only for the clients who has the permission to do it.

Create a new team and its related database

Resource: teams

URL: https://api-stage.bimplus.net/v2/teams

JSON Structure:

Name	Mandatory / Optional	Type	Description
slug	optional	string	The unique name which will be used in the url. If not set, server will generate it from the team's name.
name	mandatory	string	Name of the team
displayname	will be ignored	string	The name of the team which will be displayed in the client
owner	mandatory	string (guid)	The unique identifier of the user who will be the initial owner
totalStorage	mandatory	integer	The total storage allocated to the the team (the initial storage size as ordered in the shop)
storageStats	will be ignored	integer	The storage statistics of the team (usedSpace, numberOfProjects, numberOfMembers, totalSpace, totalNumberOfProjects, totalNumberOfMembers)
status	will be ignored	string	Active / Inactive
teamWorksConnection	optional	string	Base64 encoded database connection string for legacy applications
dataStorageStatus	optional	string	Online / Offline
public	optional	object (json)	Public read/write rights. Has two boolen properties : "read" and "write".
rights	optional	object (json)	Project rights. It's a json with only one boolean property "projectCreate", which defines whether a user can create a project for this team.
accountType	optional	string	Account type e.g. "Free", "Premium", ...

POST

Create a new team and its related database. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

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

{
    "slug": "best-company",
    "name": "Best Company",
    "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "totalStorage": 500000000,
    "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
    "dataStorageStatus": "Online",
    "haswriteaccess": false
}

Status: 201 Created

{
    "id": "db038754-2598-4616-9ea2-2c0947f2e93a",
    "slug": "best-company",
    "name": "Best Company",
    "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "totalStorage": 500000000,
    "storageStats": {
        "usedSpace": 0,
        "numberOfProjects": 0,
        "numberOfMembers": 0,
        "totalSpace": 500000000,
        "totalNumberOfProjects": 0,
        "totalNumberOfMembers": 0
    },
    "status": "Active",
    "teamWorksConnection":     "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
    "dataStorageStatus": "Online",
    "haswriteaccess": false,
    "public": {
        "read": false,
        "write": false
    },
    "rights": {
        "projectCreate": true
    }  
}

Get information about the team

Resource: teams/<team_slug>

URL: https://api-stage.bimplus.net/v2/teams/<team_slug>

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

GET

Get information about a specified team.

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

Status: 200 OK

{
    "id": "db038754-2598-4616-9ea2-2c0947f2e93a",
    "slug": "best-company",
    "name": "Best Company",
    "displayname": "Best Company (best-company)",
    "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "totalStorage": 500000000,
    "storageStats": {
        "usedSpace": 0,
        "numberOfProjects": 0,
        "numberOfMembers": 0,
        "totalSpace": 500000000,
        "totalNumberOfProjects": 0,
        "totalNumberOfMembers": 0
    },
    "status": "Active",
    "teamWorksConnection":   "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
    "dataStorageStatus": "Online",
    "public": {
        "read": false,
        "write": false
    },
    "rights": {
        "projectCreate": true
    }  
}

Update information about the team

Resource: teams/<team_slug>

URL: https://api-stage.bimplus.net/v2/teams/<team_slug>

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
slug	will be ignored	string	The unique name which will be used in the url
name	mandatory	string	Name of the team
owner	will be ignored	string (guid)	The unique identifier of the user who will be the initial owner
totalStorage	mandatory	integer	The total storage allocated to the the team (the initial storage size as ordered in the shop)
storageStats	will be ignored	integer	The storage statistics of the team (usedSpace, numberOfProjects, numberOfMembers, totalSpace, totalNumberOfProjects, totalNumberOfMembers)
status	mandatory	string	Active / Inactive
teamWorksConnection	will be ignored	string	Base64 encoded database connection string for legacy applications
dataStorageStatus	will be ignored	string	Online / Offline
haswriteaccess	will be ignored	boolean	Write access to the team
public	optional	object	Public read/write rights
read	optional	boolean	Read right (viewer right to all the projects under this team to all the registered users)
write	optional	boolean	Write right (write right to all the projects under this team to all the registered users)
rights	object	object	Project rights
projectCreate	will be ignored	boolean	The client can use this information to check whether a user can create a project for this team (See the Rights & Roles to learn more about it)

PUT

Update information about a specified team. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

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

{
        "name": "Best Company",
        "totalStorage": 500000000,
        "status": "Active"
}

Status: 200 OK

Delete the team

Resource: teams/<team_slug>

URL: https://api-stage.bimplus.net/v2/teams/<team_id>

Example: https://api-stage.bimplus.net/v2/teams/08b8195a-a2ad-11e2-9993-002215ea7d6b

DELETE

Delete a specified team. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

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

Status: 200 OK

Get the team list in which the current logged in user is a member of

Resource: teams

URL: https://api-stage.bimplus.net/v2/teams

GET

Get a team list in which the current logged in user is a member of

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

Status: 200 OK

[
    {
        "id": "db038754-2598-4616-9ea2-2c0947f2e93a",
        "slug": "best-company",
        "name": "Best Company",
        "displayname": "Best Company (best-company)",
        "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
        "totalStorage": 500000000,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
        "dataStorageStatus": "Online",
        "ismyteam": true,
        "rights": {
            "projectCreate": true
        }
    },
    {
        "id": "82884f54-96bf-4e9c-a2fb-44db8379378d",
        "slug": "nemetschek",
        "name": "Nemetschek",
        "displayname": "Nemetschek (nemetschek)",
        "owner": "132a78a5-b523-4bf2-8382-7098fac3f803",
        "totalStorage": 0,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0OyBJbml0aWFsIENhdGFsb2c9QmltUGx1cy5UZW5hbnQuRGV2OyBVc2VyIElkPWRiYmltbWFudHJvdGVzdDsgUGFzc3dvcmQ9MWprdGNudG9DcU9qeGtIMU9QOXg7IENvbm5lY3QgdGltZW91dD0xMA==",
        "dataStorageStatus": "Online",
        "ismyteam": false,
        "rights": {
            "projectCreate": false
        }
    },
    {
        "id": "7eab1453-a4e7-4d05-983e-031544540e6f",
        "slug": "bimplus-demo",
        "name": "BimPlusDemo",
        "displayname": "BimPlusDemo (bimplus-demo)",
        "owner": "5592c628-588e-f5c0-b08b-088d43de9209",
        "totalStorage": 53687091200,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5iaW1wbHVzLWRlbW87VXNlciBJRD1iaW1wbHVzLWRlbW87UGFzc3dvcmQ9YWI3ZDRmNDc5ZGM4YjI1Yjg2MDc0Y2ZmZTNiNDBjZmY2OWQwNzQ1YjtDb25uZWN0IFRpbWVvdXQ9MTA=",
        "dataStorageStatus": "Online",
        "ismyteam": false,
        "rights": {
            "projectCreate": false
        }
    }
]