Versions Compared

Old Version 362

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 363

changes.mady.by.user Jayaraj Purushothaman

Saved on

Key

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

...

Section
Column
width25%

User/Team Activation/Deactivation Service

  • Activate or deactivate the user
  • Activate or deactivate the team
  • Get Get the list of deactivated usersGet all the users with the activation status
  • Get the list of deactivated teamsall the teams with the activation status
Column
width25%

Database Server Statistics Service

Column
width25%

 

Column
width25%

 

...

Anchor
activateUser
activateUser

Activate or deactivate the user
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 (active_status can be "active" or "disabled")

mandatory

string ("active" or "disabled")

Whether to activate or deactivate the user

admin_id

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
{
    "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
activateTeam
activateTeam

Activate or deactivate the team
Deck of Cards
idbimActivateTeam
Card
labelHTTP Method
 PUT
Card
defaulttrue
labelURL / Resource / JSON Structure
 

Resource: administration/users/<userId>

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 (active_status can be "active" or "disabled")

mandatory

string ("active" or "disabled")

Whether to activate or deactivate the user

admin_id

mandatory

string

Short description of the project

reason

mandatory

string

Reason for activating/deactivating the user

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
getDeactivatedUsers
getDeactivatedUsers

Get the list of all the users with the activation status 
Deck of Cards
idbimGetDeactivatedUsers
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": "6c3bcbd4-df39-4b5c-9d55-257d15b6f2f2",
        "dbServerName": "k3345.ims-firmen.de",
        "dbServerStatus": "Active",
        "usageStatisticsIsWorking": true,
        "dbServerIsClosed": false,
        "dbSpaceTotal": 800000,
        "dbSpaceUsed": 24603,
        "growingSumLastWeekSpaceUsed": 2717,
        "growingSumLastMonthSpaceUsed": 14853,
        "growingPerDayLastWeekSpaceUsed": 388.14285714285717,
        "growingPerDayLastMonthSpaceUsed": 479.1290322580645,
        "growingDaysLastMonth": 31,
        "growingDaysLastWeek": 7,
        "dbSpaceRemaining": 775397,
        "dbSpaceRemainingPercentage": 96.9,
        "numberOfTeams": 100,
        "growingSumLastWeekTeams": 12,
        "growingSumLastMonthTeams": 63,
        "growingPerDayLastWeekTeams": 1.7142857142857142,
        "growingPerDayLastMonthTeams": 2.032258064516129,
        "numberOfProjects": 194,
        "growingSumLastWeekProjects": 30,
        "growingSumLastMonthProjects": 123,
        "growingPerDayLastWeekProjects": 4.285714285714286,
        "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,
        "dbServerIsClosed": false,
        "dbSpaceTotal": 800000,
        "dbSpaceUsed": 19011,
        "growingSumLastWeekSpaceUsed": 2114,
        "growingSumLastMonthSpaceUsed": 9595,
        "growingPerDayLastWeekSpaceUsed": 302,
        "growingPerDayLastMonthSpaceUsed": 309.51612903225805,
        "growingDaysLastMonth": 31,
        "growingDaysLastWeek": 7,
        "dbSpaceRemaining": 780989,
        "dbSpaceRemainingPercentage": 97.6,
        "numberOfTeams": 101,
        "growingSumLastWeekTeams": 12,
        "growingSumLastMonthTeams": 68,
        "growingPerDayLastWeekTeams": 1.7142857142857142,
        "growingPerDayLastMonthTeams": 2.193548387096774,
        "numberOfProjects": 147,
        "growingSumLastWeekProjects": 26,
        "growingSumLastMonthProjects": 96,
        "growingPerDayLastWeekProjects": 3.7142857142857144,
        "growingPerDayLastMonthProjects": 3.096774193548387,
        "numberOfProjectsMin": 0,
        "numberOfProjectsMax": 26,
        "teamDbSpaceMin": 20,
        "teamDbSpaceMax": 4447,
        "popularity": 98.16266,
        "unitSpace": "MB"
    }
]

Anchor
dbServerStatistics
dbServerStatistics

...