Page History

...

Deck of Cards

id	bimCreateUser

Card

default	true
label	URL / 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
firstname	optional	string	First name of the user
lastname	optional	string	Last name of the user
company	optional	string	Company of the user
displayname	optional	string	Display name of the user
info	optional	string	Information of the user
gender	optional	string	Gender of the user
phoneWork	optional	string	Office phone number of the user
phoneHome	optional	string	Home phone number of the user
fax	optional	string	Fax number of the user
mobile	optional	string	Mobile number of the user
birthDate	optional	string	Birth date of the user
address	optional	object	Address of the user
street	optional	string	Street name of the user
streetNr	optional	string	Street number of the user
zip	optional	string	Zip code
city	optional	string	City name of the user
country	optional	string	Country name of the user
preferredLanguagepreferedLanguage	optional	string	Preferred language of the user (will be set in the portal)
teams	will be ignored	array	Team list of the user
team	will be ignored	object	Information about an user's team (See the team service)
projects	will be ignored	array	Project list of the user
project	will be ignored	object	Information about an user's project (See the project service)
photo	will be ignored	string	Download link for user's photo

Card

label	HTTP Method

POST

Card

label	Description

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

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

lang

borderColor	Red
lang	xml
title	JSON	xml

{
 "email" : "test@bimplus.net",
 "password" : "test"
}

Card

label	Response

Code Block

lang

borderColor	Green
lang	xml
title	Status	xml

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "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": ""
}

...

Deck of Cards

id	bimGetUserInfo

Card

default	true
label	URL / 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

label	HTTP Method

GET

Card

label	Description

Get information about a specified user.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

lang

borderColor	Green
lang	xml
title	Status	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON
lang	xml

{
    "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": ""
}

...

Deck of Cards

id	bimUpdateUserInfo

Card

default	true
label	URL / 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

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
firstname	optional	string	First name of the user
lastname	optional	string	Last name of the user
company	optional	string	Company of the user
displayname	optional	string	Display name of the user
info	optional	string	Information of the user
gender	optional	string	Gender of the user
phoneWork	optional	string	Office phone number of the user
phoneHome	optional	string	Home phone number of the user
fax	optional	string	Fax number of the user
mobile	optional	string	Mobile number of the user
birthDate	optional	string	Birth date of the user
address	optional	object	Address of the user
street	optional	string	Street name of the user
streetNr	optional	string	Street number of the user
zip	optional	string	Zip code
city	optional	string	City name of the user
country	optional	string	Country name of the user
preferredLanguage	optional	string	Preferred language of the user (will be set in the portal)
teams	will be ignored	array	Team list of the user
team	will be ignored	object	Information about an user's team (See the team service)
projects	will be ignored	array	Project list of the user
project	will be ignored	object	Information about an user's project (See the project service)

Card

label	HTTP Method

PUT

Card

label	Description

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

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON
lang	xml

{
    "email": "updated_test@bimplus.net",
    "status": "Active",
    "password": "test"
}

Card

label	Response

Code Block

lang

borderColor	Green
lang	xml
title	Status	xml

Status: 200 OK

Anchor
deleteUser
deleteUser

...

Deck of Cards

id	bimDeleteUser

Card

default	true
label	URL / Resource / JSON Structure

Resource: users

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

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

Card

label	HTTP Method

DELETE

Card

label	Description

Delete a specified user. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Card

label	Request

Code Block

lang

borderColor	Green
lang	xml
title	Headers	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Anchor

	getCurrentUserInfo
	getCurrentUserInfo

...

Deck of Cards

id	bimGetCurrentUserInfo

Card

default	true
label	URL / Resource / JSON Structure

Resource: user

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

Card

label	HTTP Method

GET

Card

label	Description

Get information about the currently logged in user.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON
lang	xml

{
    "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": ""
}

...

Deck of Cards

id	bimUploadUserPhoto

Card

default	true
label	URL / Resource / JSON Structure

Resource: user/photo

URL: https://api-stage.bimplus.net/v2/user/photo

Example: https://api-stage.bimplus.net/v2/user/photo

Card

label	HTTP Method

POST

Card

label	Description

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.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "photo": "/attachments/dfd38a17-4d55-4f1b-a2af-f2304b79e9e8/download",
    "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
    "email": "jayaraj.purushothaman@gmail.com"
}

...

Deck of Cards

id	bimDownloadUserPhoto

Card

default	true
label	URL / Resource / JSON Structure

Resource: user/photo

URL: https://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)

Example: https://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.

Card

label	HTTP Method

GET

Card

label	Description

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)

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status
lang	xml

Status: 200 OK

Code Block

lang

borderColor	Red
lang	xml
title	JSON	xml

{
    "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": ""
}

...

Deck of Cards

id	bimForgotPassword

Card

default	true
label	URL / Resource / JSON Structure

Resource: auth-forgot

URL: https://api-stage.bimplus.net/v2/auth-forgot

Example: https://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.

Card

label	HTTP Method

POST

Card

label	Description

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.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

lang

borderColor	Red
lang	xml
title	JSON	xml

{
    "user_id": "user@bimplus.net",
    "creator_user_id": "31cb1181-2cbc-49dc-883a-0620e20140a4"
}

Card

label	Response

Code Block

lang

borderColor	Green
lang	xml
title	Status	xml

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "user_id": "user@bimplus.net",
    "creator_user_id": "31cb1181-2cbc-49dc-883a-0620e20140a4"
}

...

Deck of Cards

id	bimChangePassword

Card

default	true
label	URL / Resource / JSON Structure

Resource: change_password

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
old	mandatory	string	Old password
new	mandatory	string	New password

Card

label	HTTP Method

PUT

Card

label	Description

This API is used for changing the password.

Card

label	Request

Code Block

lang

borderColor	Green
lang	xml
title	Headers	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
"old": "old_pwd",
"new": "new_pwd"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "user_id": "user@bimplus.net",
    "creator_user_id": "31cb1181-2cbc-49dc-883a-0620e20140a4"
}

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 8

New Version 9

Key

Anchor
deleteUser
deleteUser

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 8

New Version 9

Key

AnchordeleteUserdeleteUser

Anchor
deleteUser
deleteUser