Versions Compared

Old Version 3

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 4

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
idbimUploadUserPhoto
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: users user/photo 

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

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

Card
labelHTTP Method
 POST
Card
labelDescription
 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
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
{
    "photo": "/attachments/dfd38a17-4d55-4f1b-a2af-f2304b79e9e8/download",
    "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
    "email": "jayaraj.purushothaman@gmail.com"
}

Anchor
getUserInfodownloadUserPhotogetUserInfo

...

downloadUserPhoto

Download the photo of the user
Deck of Cards
idbimGetUserInfobimDownloadUserPhoto
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: usersuser/<user_id> photo

URL: https://api-stage.bimplus.net/v2/users/<user_id>Example: user/photo OR https://api-stage.bimplus.net/v2/usersuser/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6photo?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
 Get information about a specified user. 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": ""
}