Page History

...

Anchor

	TeamService
	TeamService

Team Management Service

...

Anchor

	createTeam
	createTeam

Create a new team and its related database

Deck of Cards

id	bimCreateNewTeam

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
slug	optional	string	The unique name which will be used in the url
name	optional	string	Name of the team
owner	optional	string (guid)	The unique identifier of the user who will be the initial owner
totalStorage	optional	integer	The total storage allocated to the the team (the initial storage size as ordered in the shop)
storageStats	optional	integer	The storage statistics of the team
status	optional	string	Active / Inactive
teamWorksConnection	optional	string	Base64 encoded database connection string for legacy applications
dataStorageStatus	optional	string	Online / Offline

Card

label	Description

Create a new team and its related database.

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

{

        "slug": "best-company",
        "name": "Best Company",
        "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
        "totalStorage": 500000,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
        "dataStorageStatus": "Online"
    }

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

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

Anchor

	getTeamInfo
	getTeamInfo

Get information about the team

Deck of Cards

id	bimGetTeamInfo

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams/<team_id>

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

Example: https://api.bimplus.net/v2/teams/db038754-2598-4616-9ea2-2c0947f2e93a

Card

label	Description

Get information about 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

Anchor

	updateTeam
	updateTeam

Update information about the team

Deck of Cards

id	bimUpdateTeamInfo

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams/<team_id>

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

Example: https://api.bimplus.net/v2/teams/db038754-2598-4616-9ea2-2c0947f2e93a

JSON Structure:

Name	Mandatory / Optional	Type	Description
slug	optional	string	The unique name which will be used in the url
name	optional	string	Name of the team
owner	optional	string (guid)	The unique identifier of the user who will be the initial owner
totalStorage	optional	integer	The total storage allocated to the the team (the initial storage size as ordered in the shop)
storageStats	optional	integer	The storage statistics of the team
status	optional	string	Active / Inactive
teamWorksConnection	optional	string	Base64 encoded database connection string for legacy applications
dataStorageStatus	optional	string	Online / Offline

Card

label	Description

Update information about 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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	getTeamsFromCurrentUser
	getTeamsFromCurrentUser

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

...

Membership Management Service

...

Anchor

	addUserToTeam
	addUserToTeam

Add the user to the team

Deck of Cards

id	bimAddUserToTeam

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_id>/members

URL: https://api.bimplus.net/v2/<team>/<team_id>/members

Example:

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

Anchor

	getMembersOfTeam
	getMembersOfTeam

Get the member list of the team

Deck of Cards

id	bimGetMemberListInfo

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_id>/members

URL: https://api.bimplus.net/v2/<team>/<team_id>/members

Example:

Card

label	Description

Get information about a specified user.

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

Anchor

	updateUserInTeam
	updateUserInTeam

Update information about the user in the team

Deck of Cards

id	bimUpdateUserInfoInTeam

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_id>/members/<user_id>

URL: https://api.bimplus.net/v2/<team>/<team_id>/members/<user_id>

Example:

Card

label	Description

Update information about a specified user in a 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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	deleteUserFromTeam
	deleteUserFromTeam

Delete the user from the team

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 47

New Version 48

Key

Team Management Service

Create a new team and its related database

Get information about the team

Update information about the team

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

Membership Management Service

Add the user to the team

Get the member list of the team

Update information about the user in the team

Delete the user from the team