Versions Compared

Old Version 34

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 35

changes.mady.by.user Jayaraj Purushothaman

Saved on

Key

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

...

Composition Setup

Project Service

 Anchor
ProjectService
ProjectService
Project Service
...
 Anchor
createProject
createProject
Create a new project
 Anchor
createProject
createProject
 Deck of Cards
idbimCreateProject
 Card
labelImplementation Status
 Service available !
 Card
labelHTTP Method
POST
 Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projects 
URL: https://api.bimplus.net/v2/<team>/projects
Example: https://api.bimplus.net/v2/bimplus/projects
JSON Structure: 
 Name 
 Mandatory / Optional 
 Type 
 Description 
 name 
 optional 
 string 
 Name of the project 
 shortDescr 
 optional 
 string 
 Short description of the project 
 created 
 optional 
 string (date) 
 Creation date of the project 
 Card
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"
}

 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",
"thumbnail": null,
"created": "2013-06-01T10:05:00",
"changed": null,
"disciplines": null,
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

...

 Anchor
getProjectList
getProjectList
...
Get the Project List
...
 Deck of Cards
idbimGetProjectList
 Card
labelImplementation Status
 Service available !
 Card
labelHTTP Method
GET
 Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projects 
URL: https://api.bimplus.net/v2/<team>/projects
Example: https://api.bimplus.net/v2/bimplus/projects
 Card
labelDescription
Gets the available project list with main properties.
 Card
labelRequest
 Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

 Card
labelResponse
 Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


 Code Block
borderColorRed
langxml
titleJSON
[
    {
        "id": "586b02be-43b8-4e27-b698-e067e85e38e2",
        "name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
        "shortDescr": "Hey, i am your favourite test entry",
        "thumbnail": null,
        "created": "2013-05-01T09:33:18",
        "changed": "2013-05-01T09:33:18"
    },
    {
        "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
        "name": "Your Awesome Building",
        "shortDescr": "Example for creating a project",
        "thumbnail": null,
        "created": "0001-01-01T00:00:00",
        "changed": "0001-01-01T00:00:00"
    },
    {
        "id": "4e87944a-a477-4e4c-862e-e723dcb43066",
        "name": "UC_Fly-over Kerensheide",
        "shortDescr": null,
        "thumbnail": null,
        "created": "2013-05-10T07:13:38",
        "changed": "2013-05-16T07:34:56"
    }
]

...

 Anchor
getProjectProp
getProjectProp
...
Get the Project Properties
...
 Deck of Cards
idbimGetProjectProp
 Card
labelImplementation Status
 Service available !
 Card
labelHTTP Method
GET
 Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projects/<project_id>
URL: https://api.bimplus.net/v2/<team>/projects/<project_id>
Example: https://api.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2
 Card
labelDescription
Get all the project properties of a project using its id.
 Card
labelRequest
 Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

 Card
labelResponse
 Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


 Code Block
borderColorRed
langxml
titleJSON
{
    "name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
    "shortDescr": "Hey, i am your favourite test entry",
    "thumbnail": null,
    "created": null,
    "changed": null,
    "disciplines": [
        {
            "id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
            "name": "ID_BuildingModel",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        },
        {
            "id": "63b069d2-81df-4418-91de-8a954fa12924",
            "name": "ID_DesignModel_Timber",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        },
        {
            "id": "30114b52-bc05-47c1-80b5-c7d5485d5840",
            "name": "ID_FinishModel",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        },
        {
            "id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7",
            "name": "ID_RoomModel",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        }
    ],
    "id": "586b02be-43b8-4e27-b698-e067e85e38e2"
}

...