Versions Compared

Old Version 10

changes.mady.by.user Stanislav Slacky

Saved on

compared with

New Version 11

changes.mady.by.user Stanislav Slacky

Saved on

Key

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

...

Deck of Cards
idbimCreateUser
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: users 

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

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

JSON Structure:

Name

Mandatory / Optional

Type

Description

email

mandatory

string

Email of the user

status

optional

will be ignored

The status of the account (Active / Inactive)

password

mandatory

string

Password of the user

firstnameoptionalstringFirst name of the user
lastnameoptionalstringLast name of the user
companyoptionalstringCompany of the user
displaynameoptionalstringDisplay name of the user
infooptionalstringInformation of the user
genderoptionalstringGender of the user
phoneWorkoptionalstringOffice phone number of the user
phoneHomeoptionalstringHome phone number of the user
faxoptionalstringFax number of the user
mobileoptionalstringMobile number of the user
birthDateoptionalstringBirth date of the user
addressoptionalobjectAddress of the user
streetoptionalstringStreet name of the user
streetNroptionalstringStreet number of the user
zipoptionalstringZip code
cityoptionalstringCity name of the user
countryoptionalstringCountry name of the user
preferedLanguageoptionalstringPreferred language of the user (will be set in the portal)
teamswill be ignoredarrayTeam list of the user
teamwill be ignoredobjectInformation about an user's team (See the team service)
photowill be ignoredstringDownload link for user's photo
Card
labelHTTP Method
 POST
Card
labelDescription
 Creates a new user account. 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
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
 "email" : "test@bimplus.net",
 "password" : "test"
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created
Code Block
borderColorRed
langxml
titleJSON
{
    "teams": [],
    { "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
      "teamemail": {"test@bimplus.net",
    "status": "Active",
    "slugfirstname": "bimplus-demo",
    "lastname": "",
    "namecompany": "bimplus-demo",
        "displayname": "bimplus-demo",
     "info": "",
    "ownergender": "e0837206-4bff-65d4-b79f-f3878c3567fd",
    "phoneWork": "",
    "statusphoneHome": "Active",
    "fax": "",
    "teamWorksConnectionmobile": null"",
    "birthDate": "",
    "dataStorageStatusaddress": null,{
        "ismyteamstreet": false"",
        "rightsstreetNr": null"",
        "idzip": "ba790aa0-8631-410b-842f-1ee53349e0ae"
      }
    },
    {
      "teamcity": {
        "slug": "test-company",
        "namecountry": "Test Company",
    },
    "displaynamepreferedLanguage": "emrazek-extern"
}

Anchor
getUserInfo
getUserInfo

Get information about the user
Deck of Cards
idbimGetUserInfo
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: users/<user_id> 

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

Example: https://api-stage.bimplus.net/v2/users/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

Card
labelHTTP Method
 GET
Card
labelDescription
 Get information about a specified user.
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
{
  "teams": [
    {
      "team": {
        "slug": "bimplus-demo",
        "name": "bimplus-demo",
      ,
        "owner": "3d676814-cf37-aa43-ed03-4b156c282fa1",
        "status": "Active",
        "teamWorksConnection": null,
        "dataStorageStatus": null,
        "ismyteam": true,
        "rights": null,
        "id": "870ce403-9d5c-4e58-8684-9eb3e2fc8daf"
      }
    }    
  ],
  "id": "3d676814-cf37-aa43-ed03-4b156c282fa1",
  "email": "testuser@allplan.com",
  "status": "Active",
  "firstname": "Test",
  "lastname": "User",
  "company": "Allplan",
  "fullname": "Test User",
  "displayname": "Test User [Allplan]bimplus-demo",
  "info": "",
      "genderowner": "MRe0837206-4bff-65d4-b79f-f3878c3567fd",
        "phoneWorkstatus": "Active",
        "phoneHometeamWorksConnection": ""null,
  "fax": "",
  "mobile": "123",
  "birthDatedataStorageStatus": "0000-00-00"null,
  "address": {
      "streetismyteam": "jarosova "false,
        "streetNrrights": "1"null,
        "zipid": "83102",
ba790aa0-8631-410b-842f-1ee53349e0ae"
      "city": "Bratislava",}
    },
    {
      "countryteam": "8f241f1109647a265.29938154"{
  },
      "preferedLanguageslug": "entest-company"
}

...

Get information about the user
Deck of Cards
idbimGetUserInfo
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: users/<user_id> 

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

Example: https://api-stage.bimplus.net/v2/users/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

Card
labelHTTP Method
 GET
Card
labelDescription
 Get information about a specified user.
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
{
    "projects": [],
    "teams": [],
    "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "email": "test@bimplus.net",
    ,
        "name": "Test Company",
        "displayname": "Test Company",
        "owner": "3d676814-cf37-aa43-ed03-4b156c282fa1",
        "status": "Active",
        "teamWorksConnection": null,
        "dataStorageStatus": null,
        "ismyteam": true,
        "rights": null,
        "id": "870ce403-9d5c-4e58-8684-9eb3e2fc8daf"
      }
    }    
  ],
  "id": "3d676814-cf37-aa43-ed03-4b156c282fa1",
  "email": "testuser@allplan.com",
  "status": "Active",
    "firstname": "Test",
  "lastname": "User",
  "lastnamecompany": "Allplan",
    "companyfullname": "Test User",
    "displayname": "Test User [Allplan]",
    "info": "",
    "gender": "MR",
    "phoneWork": "",
    "phoneHome": "",
    "fax": "",
    "mobile": "123",
    "birthDate": "0000-00-00",
    "address": {
        "street": "jarosova ",
        "streetNr": "1",
        "zip": "83102",
        "city": "Bratislava",
        "country": "8f241f1109647a265.29938154"
    },
    "preferedLanguage": "en"
}

Anchor
updateUser
updateUser

...