Versions Compared

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 the list of all the users with the activation status
  • Get the list of all the teams with the activation status
  • Get the activation status and the status log for an user
  • Get the activation status and the status log for a team
Column
width25%

Database Server Statistics Service


Column
width25%

 

Column
width25%

 

...

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

Resourceadministration/users/<userId>

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

Examplehttps://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
{
    "activeStatus": "Disabled",
    "adminId": "e041e7312da9e4ac64403fbcdde21517",
    "propertiesreason": "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",
    "MainFloorAreaemail": "456m²test@bimplus.net",
    "status": "Disabled",
    "ArchitectadminLog": [
        {
            "nameid": "NemetschekTech.GmbH43d3187e-87a5-4e11-9f68-a2c90097e2ba",
            "phone1action": "089/12793-1115Disabled",
            "phone2author": "0171/71384483ae041e7312da9e4ac64403fbcdde21517a",
            "emailreason": "MyName@Nemetschek.comTesting the deactivate functionality",
            "citytimestamp": "Munich",
2014-02-05T08:12:59.9252404Z"
        },
        {
     "zip       "id": "818290f2d654a-3630-4ec9-9039-a2c900977117",
            "streetaction": "Konrad-Zuse-Platz1Active",
            } "author": "ae041e7312da9e4ac64403fbcdde21517a",
            "Customerreason": { "Testing the deactivate functionality",
            "nametimestamp": "Bimplus customer",2014-02-05T08:11:22.9546122"
        },
        {
            "phone1id": "001-201-1279345e6081130-7ab5-45a7-a168-a2c8012a560a",
            "emailaction": "MyName@Nemetschek.comDisabled",
            "cityauthor": "New Jersyae041e7312da9e4ac64403fbcdde21517a",
            "zipreason": "08201"
Testing the deactivate functionality",
             }"timestamp": "2014-02-04T17:06:12.5076209"
    }
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
    }
    ]
}


Anchor
activateTeam
activateTeam

...