Page History

...

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> slug>

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

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

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

...

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> slug>

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

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

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

...

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>slug>/members

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

Example: https://api.bimplus.net/v2/best-company/members^{Image Added}

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

...

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>slug>/members

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

Example: https://api.bimplus.net/v2/best-company/members^{Image Added}

Card

label	Description

Get information about Gets the member list of a specified userteam.

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

...

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>slug>/members/<user_id>

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

Example: https://api.bimplus.net/v2/best-company^{Image Added}>/members/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

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

...

Deck of Cards

id	bimDeleteUserFromTeam

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_id>slug>/members/<user_id>

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

Example: https://api.bimplus.net/v2/best-company/members/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6^{Image Added}

Card

label	Description

Deletes a specified user from a 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

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 67

New Version 68

Key