Versions Compared

Old Version 10

changes.mady.by.user Eduard Mrazek

Saved on

compared with

New Version 11

changes.mady.by.user Eduard Mrazek

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 9

...

Deck of Cards
idbimCreateNewTeam
Card
defaulttrue
labelURL / Resource / JSON Structure
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

displaynamewill be ignoredstringThe 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 (MB)

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 / Disabled

teamWorksConnection

optional

string

Base64 encoded database connection string for legacy applications

dataStorageStatus

optional

string

Online / Offline

publicoptionalobject (json)Public read/write rights. Has two boolen properties : "read" and "write".
rightsoptionalobject (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.
accountTypeoptionalstringAccount type e.g. "Free", "Premium", ...
ismyteamwill be ignoredbooleanIs this team the user's team - true/false
Card
labelHTTP Method
 POST
Card
labelDescription
 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)
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
    "slug": "best-company",
    "name": "Best Company",
    "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "totalStorage": 500000000,
    "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
    "dataStorageStatus": "Online",
    "haswriteaccess": false
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created
Code Block
borderColorRed
langxml
titleJSON
{
    "id": "db038754-2598-4616-9ea2-2c0947f2e93a",
    "slug": "best-company",
    "name": "Best Company",
    "displayname" : "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",
    "ismyteam": true,
    "public": {
        "read": false,
        "write": false
    },
    "rights": {
        "projectCreate": true
    }  
}

...