Versions Compared

Old Version 24

changes.mady.by.user Stanislav Slacky

Saved on

compared with

New Version 25

changes.mady.by.user Stanislav Slacky

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Deck of Cards
idbimCreateProject
Card
labelURL / Resource / JSON Structure
Resource: projects 

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

Example: https://api-stage.bimplus.net/v2/bimplus/projects

JSON Structure: 

Name

Mandatory / Optional

Type

Description

idwill be ignoredstring (guid)Id of the project

name

mandatory

string

Name of the project

shortDescr

optional

string

Short description of the project

teamNamewill be ignoredstringName of the team to which the project belongs
teamSlugwill be ignoredstringSlug of the team to which the project belongs
hasWriteAccesswill be ignoredbooleanDon't use this property. This property is not deleted to support the older clients
thumbnailwill be ignoredstringDirect download link to project thumbnail

created

will be ignored

string (date)

Creation date of the project

createdBywill be ignoredJSON objectDetails of the Bimplus user who has created the project
changedwill be ignoredstring(date)Modified date of the project
changedBywill be ignoredJSON objectDetails of the Bimplus user who has created the project
addressoptionalstringAddress of the project
modelCountwill be ignoredintNumber of models in this project
memberCountwill be ignoredintNumber of members in this project
topicCountwill be ignoredintNumber of topics in this project
attachmentCountwill be ignoredintNumber of attachments in this project
sizewill be ignoredintSize of the project in bytes
sizeInMBwill be ignoredstringSize of the project in MB
disciplineswill be ignoredJSON objectDisciplines found under this project
rightswill be ignoredJSON objectThe rights the user has for this project
Card
labelHTTP Method
 POST
Card
defaulttrue
labelDescription
 Creates a new project.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
    "name" : "Your Awesome Building",
    "shortDescr" : "Example for creating a project",
    "address" : "My address somewhere"
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created
Code Block
borderColorRed
langxml
titleJSON
{
    "name": "Your Awesome Building",
    "shortDescr": "Example for creating a project",
    "teamName": "Best Company",
    "teamSlug": "best-company",
    "hasWriteAccess" : true,
    "thumbnail": null,
    "created": "2013-06-01T10:05:00",
    "createdby" : {
        "id": "7c555899-5a5f-44d1-930e-284930678bed",
        "email" : "testuser@bimplus.net"
    },
    "changed": "2013-06-01T10:05:00",
    "changedby" : {
        "id": "7c555899-5a5f-44d1-930e-284930678bed",
        "email" : "testuser@bimplus.net"
    },
    "address" : "My address somewhere",
    "modelCount": 0,
    "memberCount": 1,
    "topicCount": 0,
    "attachmentCount": 0,
    "size": 0,
    "sizeMB": "0",
    "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

...