Versions Compared

Key

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

...

Deck of Cards
idbimGetCurrentProjectList
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projects 

URLhttps://api-stage.bimplus.net/v2/projects

Examplehttps://api-stage.bimplus.net/v2/projects

Card
labelHTTP Method
 GET
Card
labelDescription
 Gets the entire list of projects in which the logged in user is a member
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": "",
        "created": "2013-05-01T09:33:18",
        "createdby" : {
            "id" : "f4b1178d-385f-449c-a2a7-6f58b264d90c"
            "email" : "owner@company1.com",
        },
        "changed": "2013-05-01T09:33:18",
        "changedby" : {
            "id" : "f4b1178d-385f-449c-a2a7-6f58b264d90c"
            "email" : "owner@company1.com",
        },
        "address" : "Address of company 1"
        "hasWriteAccess": false,
        "teamSlug": "company1",
        "modelCount" : 3,
        "memberCount" : 3,
        "size" : 63488,
        "sizeMB" : "0.06",
        "rights": {
            "projectAdmin": false,
            "projectDelete": false,
            "projectEdit": false,
            "modelsCreate": false,
            "modelsViewAll": false
        }
    },
    {
        "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
        "name": "Your Awesome Building",
        "shortDescr": "Example for creating a project",
        "thumbnail": null"",
        "created": "0001-01-01T00:00:00",
        "createdby" : {
            "id": "7c555899-5a5f-44d1-930e-284930678bed",
            "email" : "testuser@bimplus.net"
        },
        "changed": "0001-01-01T00:00:00",
        "changedby" : {
            "id": "7c555899-5a5f-44d1-930e-284930678bed",
            "email" : "testuser@bimplus.net"
        },
        "address" : "My address somewhere",
        "hasWriteAccess": true,
        "teamSlug": "best-company",
        "modelCount": 4,
        "memberCount": 2,
        "size" : 4263936,
        "sizeMB" : "4,07",
        "rights": {
            "projectAdmin": true,
            "projectDelete": true,
            "projectEdit": true,
            "modelsCreate": true,
            "modelsViewAll": true
        }
    }
]

...

Deck of Cards
idbimGetProjectList
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projects 

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

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects

Card
labelHTTP Method
 GET
Card
labelDescription
 Gets the project list with main properties from a particular team in which the user is a member of.
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": "586b02be0d2ce2cc-43b83588-4e2745d6-b698a59a-e067e85e38e2f6b89ebed34e",
        "name": "!!!!!_VORTEILSHAUS V40 SD45 TraufeingangYour Awesome Building",
        "shortDescr": "Hey,Example ifor amcreating your favourite test entrya project",
        "thumbnail": null"",
        "created": "20130001-0501-01T0901T00:3300:1800",
        "changedcreatedby" : "2013-05-01T09:33:18",{
            "hasWriteAccessid": false"7c555899-5a5f-44d1-930e-284930678bed",
            "teamSlugemail" : "company1testuser@bimplus.net",
        "rights": {
  },
          "projectAdminchanged": false"0001-01-01T00:00:00",
            "projectDeletechangedby" : false,{
            "id": "7c555899-5a5f-44d1-930e-284930678bed",
            "email" : "testuser@bimplus.net"
        },
        "address" : "My address somewhere",
        "hasWriteAccess": true,
        "teamSlug": "best-company",
        "modelCount": 4,
        "memberCount": 2,
        "size" : 4263936,
        "sizeMB" : "4,07",
        "rights": {
            "projectAdmin": true,
            "projectDelete": true,
            "projectEdit": falsetrue,
            "modelsCreate": falsetrue,
            "modelsViewAll": falsetrue
        }
    },
    {
        "id": "0d2ce2cc4e87944a-3588a477-45d64e4c-a59a862e-f6b89ebed34ee723dcb43066",
        "name": "Your Awesome BuildingUC_Fly-over Kerensheide",
        "shortDescr": "Example for creating a project",
        "thumbnail": null"",
        "created": "00012013-0105-01T0010T07:0013:0038",
        "changedcreatedby" : "0001-01-01T00:00:00",{
        "hasWriteAccess": true,
        "teamSlugid": "best-company",
        "rights": {bda91f09-2cc6-45da-bba0-5f92828f58bc",
            "projectAdminemail" : true,"UserA@bimplus.net"
            "projectDelete": true},
            "projectEditchanged": true"2013-05-16T07:34:56",
            "modelsCreatechangedby" : true,{
            "modelsViewAllid": true"7c555899-5a5f-44d1-930e-284930678bed",
        }
    },
    {"email" : "testuser@bimplus.net"
        "id": "4e87944a-a477-4e4c-862e-e723dcb43066"},
        "nameaddress" : "UC_Fly-over Kerensheide",
        "shortDescrhasWriteAccess": nulltrue,
        "thumbnailteamSlug": null"best-company",
        "createdmodelCount": "2013-05-10T07:13:38"2,
        "changedmemberCount": "2013-05-16T07:34:56"3,
        "hasWriteAccesssize": false63488,
        "teamSlugsizeMB": "company20,06",
        "rights": {
            "projectAdmin": false,
            "projectDelete": false,
            "projectEdit": falsetrue,
            "modelsCreate": false,
            "modelsViewAll": true
        }
    }
]

...