Versions Compared

Old Version 364

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 365

changes.mady.by.user Jayaraj Purushothaman

Saved on

Key

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

...

Deck of Cards
idbimActivateUser
Card
labelHTTP Method
 PUT
Card
defaulttrue
labelURL / Resource / JSON Structure
 

Resource: administration/users/<userId>

URL: https://api-stage.bimplus.net/v2/administration/users/<userId>

Example: https://api-stage.bimplus.net/v2/administration/users/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

JSON Structure: 

Name

Mandatory / Optional

Type

Description

active_status activeStatus (active_status can be "active" or "disabled")

mandatory

string ("active" or "disabled")

Whether to activate or deactivate the user

admin_idadminId

mandatory

string

Short description of the project

reason

mandatory

string

Reason for activating/deactivating the user

Card
labelDescription
 Activate or deactivate the specified user. 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
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "activeStatus": "Disabled",
    "adminId": "e041e7312da9e4ac64403fbcdde21517",
    "reason": "Testing the deactivate functionality"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorGreen
titleResponse
langxml
{
    "id": "237c8f43-a01b-c6e8-0c14-d167620466ed",
    "email": "test@bimplus.net",
    "status": "Disabled",
    "adminLog": [
        {
            "id": "43d3187e-87a5-4e11-9f68-a2c90097e2ba",
            "action": "Disabled",
            "author": "ae041e7312da9e4ac64403fbcdde21517a",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-05T08:12:59.9252404Z"
        },
        {
            "id": "0f2d654a-3630-4ec9-9039-a2c900977117",
            "action": "Active",
            "author": "ae041e7312da9e4ac64403fbcdde21517a",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-05T08:11:22.9546122"
        },
        {
            "id": "e6081130-7ab5-45a7-a168-a2c8012a560a",
            "action": "Disabled",
            "author": "ae041e7312da9e4ac64403fbcdde21517a",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-04T17:06:12.5076209"
        }
    ]
}

...

Deck of Cards
idbimActivateTeam
Card
labelHTTP Method
 PUT
Card
defaulttrue
labelURL / Resource / JSON Structure
 

Resource: administration/users/<userId><teamId>

URL: https://api-stage.bimplus.net/v2/administration/teams/<teamId>

Example: https://api-stage.bimplus.net/v2/administration/teams/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

JSON Structure: 

Name

Mandatory / Optional

Type

Description

active_status activeStatus (active_status can be "active" or "disabled")

mandatory

string ("active" or "disabled")

Whether to activate or deactivate the userteam

admin_idadminId

mandatory

string

Short description of the project

reason

mandatory

string

Reason for activating/deactivating the userteam

Card
labelDescription
 Activate or deactivate the specified team. 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
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "properties": {
        "MainFloorArea": "456m²",
        "Architect": {
            "name": "NemetschekTech.GmbH",
            "phone1": "089/12793-1115",
            "phone2": "0171/71384483",
            "email": "MyName@Nemetschek.com",
            "city": "Munich",
            "zip": "81829",
            "street": "Konrad-Zuse-Platz1"
        },
        "Customer": {
            "name": "Bimplus customer",
            "phone1": "001-201-1279345",
            "email": "MyName@Nemetschek.com",
            "city": "New Jersy",
            "zip": "08201"
        }
    }
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

 

Anchor
getDeactivatedUsersgetUserActivationStatusgetDeactivatedUsers
getUserActivationStatus

Get the list of all the users with the activation status 
Deck of Cards
idbimGetDeactivatedUsersbimGetUserActivationStatus
Card
labelHTTP Method
 GET
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: administration/users

URL: https://api-stage.bimplus.net/v2/administration/users

Example: https://api-stage.bimplus.net/v2/administration/users

Card
labelDescription

 Get the list of all the users with the activation status. 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
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
 [
    {
        "id": "6c3bcbd46790ad40-df3999e1-4b5ccef2-9d55cabd-257d15b6f2f21bd05bbb3335",
        "dbServerNameemail": "k3345.ims-firmen.deuser1@bimplus.net",
        "dbServerStatusstatus": "Active",
    },
    "usageStatisticsIsWorking": true,{
        "dbServerIsClosedid": false,
        "dbSpaceTotal": 800000"43d2d1c8-f0eb-9804-d2a2-1f36c8fb7a45",
        "dbSpaceUsedemail": 24603,
        "growingSumLastWeekSpaceUsed": 2717"user2@bimplus.net",
        "growingSumLastMonthSpaceUsedstatus": 14853,
        "growingPerDayLastWeekSpaceUsed": 388.14285714285717,"Disabled"
        "growingPerDayLastMonthSpaceUsed": 479.1290322580645},
        "growingDaysLastMonth": 31,{
        "growingDaysLastWeekid": 7,
        "dbSpaceRemaining": 775397"39b31bb4-b413-3dc9-6036-214392facb49",
        "dbSpaceRemainingPercentageemail": 96"user3@bimplus.9net",
        "numberOfTeamsstatus": 100,"Active"
        "growingSumLastWeekTeams": 12},
        "growingSumLastMonthTeams": 63,{
        "growingPerDayLastWeekTeamsid": 1.7142857142857142,
        "growingPerDayLastMonthTeams": 2.032258064516129"91188cc9-6202-a9e9-8ada-23fbca9c7b34",
        "numberOfProjectsemail": 194,
        "growingSumLastWeekProjects": 30"user4@bimplus.net",
        "growingSumLastMonthProjectsstatus": 123,
        "growingPerDayLastWeekProjects": 4.285714285714286,"Active"
        "growingPerDayLastMonthProjects": 3.967741935483871,
        "numberOfProjectsMin": 0,
        "numberOfProjectsMax": 32,
        "teamDbSpaceMin": 20,
        "teamDbSpaceMax": 3017,
        "popularity": 98.5742,
        "unitSpace": "MB"
    },
    {
        "id": "c37d4829-b547-4c8d-b031-ffd2101b7c54",
        "dbServerName": "k2222.ims-firmen.de",
        "dbServerStatus": "Active",
        "usageStatisticsIsWorking": true,}
]

 

Anchor
getUserActivationStatus
getUserActivationStatus

Get the list of all the teams with the activation status 
Deck of Cards
idbimGetTeamActivationStatus
Card
labelHTTP Method
 GET
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: administration/teams

URL: https://api-stage.bimplus.net/v2/administration/teams

Example: https://api-stage.bimplus.net/v2/administration/teams

Card
labelDescription

 Get the list of all the teams with the activation status. 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
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
[
    {
        "dbServerIsClosedid": false,
        "dbSpaceTotal": 800000"c9e80035a-de61-4d84-b324-0308cc073a0c",
        "dbSpaceUsedslug": 19011,
        "growingSumLastWeekSpaceUsedtestteam": 2114,
        "growingSumLastMonthSpaceUsedname": 9595,
        "growingPerDayLastWeekSpaceUsed": 302"testteam",
        "growingPerDayLastMonthSpaceUsedserver": 309.51612903225805"k2145.ims-firmen.de",
        "growingDaysLastMonthownerId": 31"fc5d0b370-6005-484c-8f47-b9e52e8ac6eaf",
        "growingDaysLastWeekstatus": 7"Active",
        "dbSpaceRemainingcountMembers": 7809891,
        "dbSpaceRemainingPercentagecountProjects": 97.6608,
        "numberOfTeamsusedSpace": 101,1973
    },
    "growingSumLastWeekTeams": 12,{
        "growingSumLastMonthTeamsid": 68,
        "growingPerDayLastWeekTeams": 1.7142857142857142"a1e500195-b9cc-495c-bb3a-ab01ada0ca01a",
        "growingPerDayLastMonthTeamsslug": 2.193548387096774,
        "numberOfProjects": 147"bimplus-gmbh",
        "growingSumLastWeekProjectsname": 26,
        "growingSumLastMonthProjects": 96"Bimplus GmbH",
        "growingPerDayLastWeekProjectsserver": 3.7142857142857144"k2145.ims-firmen.de",
        "growingPerDayLastMonthProjectsownerId": 3.096774193548387,
        "numberOfProjectsMin": 0"g6e67ba07-50c3-d51d-23f0-3ac0d8788202g",
        "numberOfProjectsMaxstatus": 26,
        "teamDbSpaceMinActive": 20,
        "teamDbSpaceMaxcountMembers": 44471,
        "popularitycountProjects": 98.162663,
        "unitSpaceusedSpace": "MB"237
    }
]

Anchor
dbServerStatistics
dbServerStatistics

...