Versions Compared

Key

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

...

Deck of Cards
idbimUpdateUserInfo
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: users/<user_id> 

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

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

JSON Structure:

Name

Mandatory / Optional

Type

Description

email

mandatory

string

Email of the user

status

mandatory

string

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
preferredLanguageoptionalstringPreferred 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)
projectswill be ignoredarrayProject list of the user
projectwill be ignoredobjectInformation about an user's project (See the project service)
Card
labelHTTP Method
 PUT
Card
labelDescription
 Update information about a 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
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
    "email": "updated_test@bimplus.net",
    "status": "Active",
    "password": "test"
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

...