Versions Compared

Old Version 5

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 6

changes.mady.by.user Jayaraj Purushothaman

Saved on

Key

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

...

User Management Service

...

Anchor
createUser
createUser

...

Deck of Cards
idbimDownloadUserPhoto
Card
defaulttrue
labelURL / 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
labelHTTP Method
 GET
Card
labelDescription
 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
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
{
    "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": ""
}

Anchor
forgotPassword
forgotPassword

Forgot Password or Resend Invitation
Deck of Cards
idbimForgotPassword
Card
defaulttrue
labelURL / 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
labelHTTP Method
 POST
Card
labelDescription
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&forgot_password) which will take the user to "Forgot Password" page or to the "User Activation/Registration"(eg: <url>#/activate?email=<email>&cross_token=xxx&accept_invitation) 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. Please note that, if the user has not confirmed the invitation then subsequent invitations will be sent (1 per week). After a month, unaccepted user invitation will expire.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "user_id": "user@bimplus.net",
    "creator_user_id": "31cb1181-2cbc-49dc-883a-0620e20140a4"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 201 Created
Code Block
borderColorRed
titleJSON
langxml
{
    "user_id": "user@bimplus.net",
    "creator_user_id": "31cb1181-2cbc-49dc-883a-0620e20140a4"
}

Anchor
changePassword
changePassword

Change Password
Deck of Cards
idbimChangePassword
Card
defaulttrue
labelURL / 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
labelHTTP Method
 PUT
Card
labelDescription
This API is used for changing the password.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
"old": "old_pwd",
"new": "new_pwd"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
{
    "user_id": "user@bimplus.net",
    "creator_user_id": "31cb1181-2cbc-49dc-883a-0620e20140a4"
}