Versions Compared

Old Version 27

changes.mady.by.user Peter Balogh

Saved on

compared with

New Version 28

changes.mady.by.user Peter Balogh

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 / Disabled)

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 (values MR, MS)
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
preferedLanguageoptionalstringPreferred language of the user (will be set in the portal

"en", "de", "fr", "ru", "it", "es", "cs", "tr", "us", "ro"

)
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
hasAcceptedTermsoptionalboolAccept terms and conditions



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",
    "email": "test@bimplus.net",
    "status": "Active",
    "firstname": "",
    "lastname": "",
    "company": "",
    "displayname": "",
    "info": "",
    "gender": "",
    "phoneWork": "",
    "phoneHome": "",
    "fax": "",
    "mobile": "",
    "birthDate": "",
    "address": {
        "street": "",
        "streetNr": "",
        "zip": "",
        "city": "",
        "country": ""
    },
    "preferedLanguage": ""
}



...