Versions Compared

Old Version 366

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 367

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

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

mandatory

string ("active" or "disabled")

Whether to activate or deactivate the user

adminId

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": "e041e7312da9e4ac64403fbcdde21517ade041e7312da9e4aghc64403fbcd21517ttt",
    "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": "ae041e7312da9e4ac64403fbcdde21517aade041e7312da9e4aghc64403fbcd21517ttt",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-05T08:12:59.9252404Z"
        },
        {
            "id": "0f2d654a-3630-4ec9-9039-a2c900977117",
            "action": "Active",
            "author": "ae041e7312da9e4ac64403fbcdde21517aade041e7312da9e4aghc64403fbcd21517ttt",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-05T08:11:22.9546122"
        },
        {
            "id": "e6081130-7ab5-45a7-a168-a2c8012a560a",
            "action": "Disabled",
            "author": "ae041e7312da9e4ac64403fbcdde21517aade041e7312da9e4aghc64403fbcd21517ttt",
            "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/<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

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

mandatory

string ("active" or "disabled")

Whether to activate or deactivate the team

adminId

mandatory

string

Short description of the project

reason

mandatory

string

Reason for activating/deactivating the team

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
{
    "propertiesactiveStatus": {"disabled",
        "MainFloorAreaadminId": "456m²ase041e7312da9ert4ac64403fbcdde21517h",
    "reason": "Testing the deactivate "Architect": {
            "name": "NemetschekTech.GmbH",
            "phone1": "089/12793-1115",
            "phone2": "0171/71384483",
           functionality"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorGreen
titleResponse
langxml
{
 "publicRead": false,
 "publicWrite": false,
 "teamDbName": "BimPlus.Tenant.Dev.jay-company",
 "payment": null,
 "lastLogin": "0001-01-01T00:00:00",
 "failedLogins": 0,
 "owner": {
 "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
 "email": "MyName@Nemetschekjayaraj.purushothaman@gmail.com",
            "city"firstname": "MunichJayaraj",
            "ziplastname": "81829Purushothaman",
 "company": "Jay          "streetCompany",
 "fullname": "Konrad-Zuse-Platz1"Jayaraj Purushothaman",
 "displayname": "Jayaraj Purushothaman     }[Jay Company]",
        "Customerinfo": {
            "name"",
 "gender": "Bimplus customerMR",
 "phoneWork": "",
 "phoneHome": "",
 "fax": "",
 "mobile": "",
 "birthDate": "0000-00-00",
 "address": {
 "street": "Konrad Zuse platz",
 "streetNr": "1",
 "zip": "81829",
 "city": "Munich",
 "country": "Germany"
 },
 "preferedLanguage": "de",
 "wrongLogins": 0
 },
 "invitees": 2,
 "teamMembers": [
 {
 "phone1id": "001-201-1279345",
           6e67ba07-50c3-d51d-23f0-3ac0d8788202",
 "firstname": "Unknown",
 "lastName": "User",
 "fullName": "Unknown User",
 "email": "jayaraj.purushothaman@bimplus.net",
 "roleName": null,
 "invitationStatus": null
 },
 {
 "id": "237c8f43-a01b-c6e8-0c14-d167620466ed",
 "firstname": "Unknown",
 "lastName": "User",
 "fullName": "Unknown User",
 "email": "MyName@Nemetschekssudha84@gmail.com",
 "roleName": null,
 "invitationStatus": null
 }
 ],
 "adminLog": [
 {
 "id": "efb4a35a-b47b-4b81-bebf-a2cb00a0317f",
 "cityaction": "Disabled",
 "New Jersyauthor": "ase041e7312da9ert4ac64403fbcdde21517h",
 "reason": "Testing the deactivate functionality",
 "timestamp": "2014-02-07T08:43:14.7675944Z"
 },
 {
 "id": "ab516ade-a01a-4938-8c28-a2cb00a02170",
 "zipaction": "08201Active",
 "author": "ase041e7312da9ert4ac64403fbcdde21517h",
 "reason": "Testing the deactivate functionality",
 "timestamp": "2014-02-07T08:43:01.0644085"
 }
 ],
 "id":  }
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
"c3018713-a313-4bab-a952-2fddb58fb171",
 "slug": "jay-company",
 "name": "Jay Company",
 "server": "k2146.ims-firmen.de",
 "ownerId": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
 "status": "Disabled",
 "countMembers": 3,
 "countProjects": 1,
 "usedSpace": 106
}


Anchor
getUsersActivationStatus
getUsersActivationStatus

...