User Management Service


User Management Service


Please remember that creating/updating/deleting an user is possible only for the clients who has the permission to do it.

Create a new user
 Resource: users 

URLhttps://api-stage.bimplus.net/v2/users

Examplehttps://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
 POST
 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)
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
 "email" : "test@bimplus.net",
 "password" : "test"
}
Status: 201 Created
{
    "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": ""
}

Get information about the user
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

 GET
 Get information about a specified user.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
  "teams": [
    {
      "team": {
        "slug": "bimplus-demo",
        "name": "bimplus-demo",
        "displayname": "bimplus-demo",
        "owner": "e0837206-4bff-65d4-b79f-f3878c3567fd",
        "status": "Active",
        "teamWorksConnection": null,
        "dataStorageStatus": null,
        "ismyteam": false,
        "rights": null,
        "id": "ba790aa0-8631-410b-842f-1ee53349e0ae"
      }
    },
    {
      "team": {
        "slug": "test-company",
        "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",
  "company": "Allplan",
  "fullname": "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"
}

Update information about the user
 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)
 PUT
 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)
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "email": "updated_test@bimplus.net",
    "status": "Active",
    "password": "test"
}
Status: 200 OK
Delete the user
Resource: users

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

Examplehttps://api-stage.bimplus.net/v2/users/08b8195a-a2ad-11e2-9993-002215ea7d6b

 DELETE
 Delete a specified user. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Get information about the currently logged in user
Resource: user 

URLhttps://api-stage.bimplus.net/v2/user

 GET
 Get information about the currently logged in user.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "projects": [],
    "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": ""
}

Upload a photo of the user
 Resource: user/photo 

URLhttps://api-stage.bimplus.net/v2/user/photo

Examplehttps://api-stage.bimplus.net/v2/user/photo

 POST
 Upload a photo of the user. The token can also be passed as the query string if the client cannot use the token in the header request.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Status: 200 OK
{
    "photo": "/attachments/dfd38a17-4d55-4f1b-a2af-f2304b79e9e8/download",
    "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
    "email": "jayaraj.purushothaman@gmail.com"
}

Download the photo of the user
Resource: user/photo

URLhttps://api-stage.bimplus.net/v2/user/photo OR https://api-stage.bimplus.net/v2/user/photo?api-token=token (If the client cannot use the token in the header request)

Examplehttps://api-stage.bimplus.net/v2/user/photo OR https://api-stage.bimplus.net/v2/user/photo?api-token=9c1874a62c974dcfa75e0132c423a088

The photo could also be downloaded by using the the property of "photo"(which is a url) in the v2/user json response.

 GET
 Download the photo of the user. The token can be also provided as the query string for downloading the attachment( If the client cannot use the token in the header request)
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "projects": [],
    "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": ""
}

Forgot Password or Resend Invitation
 Resource: auth-forgot 

URLhttps://api-stage.bimplus.net/v2/auth-forgot

Examplehttps://api-stage.bimplus.net/v2/auth-forgot

JSON Structure:

Name

Mandatory / Optional

Type

Description

user_id

mandatory

string(guid)

Recipient user_id (i.e the user who has triggered the forgot password action or the user who will be re-invited to join the team)

creator_user_id

optional

string(guid)

This will be used only for the re-send invitation case to identify the user who has sent the invitation.

 POST
This API is used for two purposes. It can be used if the user has forgot the password(in this case, the creator_user_id parameter will be ignored) This API is also used for re-inviting an user to join his team/project where "creator_user_id" is the id of the user who sent the invitation. In both the cases, the recipient will get an email with the link(eg: <url>#/forgot_password?email=<email>&cross_token=xxx) which will take the user to "Forgot Password" page or to the "User Activation/Registration"(eg: <url>#/accept_invitation?email=<email>&cross_token=xxx) page. The validity of the cross-token is different on each case. For forgot password, the token is 1 day valid & for the invitation it is 1 week valid.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "user_id": "user@bimplus.net",
    "creator_user_id": "31cb1181-2cbc-49dc-883a-0620e20140a4"
}
Status: 201 Created
{
    "user_id": "user@bimplus.net",
    "creator_user_id": "31cb1181-2cbc-49dc-883a-0620e20140a4"
}

Change Password
Resource: change_password 

URLhttps://api-stage.bimplus.net/v2/change_password

Examplehttps://api-stage.bimplus.net/v2/change_password

JSON Structure:

Name

Mandatory / Optional

Type

Description

old

mandatory

string

Old password

new

mandatory

string

New password

 PUT
This API is used for changing the password.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
"old": "old_pwd",
"new": "new_pwd"
}
Status: 200 OK
{
    "user_id": "user@bimplus.net",
    "creator_user_id": "31cb1181-2cbc-49dc-883a-0620e20140a4"
}