Versions Compared

Old Version 6

changes.mady.by.user Ivan Pavlovcik

Saved on

compared with

New Version 7

changes.mady.by.user Ivan Pavlovcik

Saved on

Key

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

...

Deck of Cards
idbimAcceptInvitation
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: <teamslug>/invitations/<invitation_id>/accept

URL: https://api-stage.bimplus.net/v2/users/<teamslug>/invitations/<invitation_id>/accept

Example: https://api-stage.bimplus.net/v2/bimplus/invitations/55896fad-187e-47da-bdb6-b441607e3de3/accept

Card
labelHTTP Method
 PUT
Card
labelDescription
 Since this api call will create new user in Bimplus, the request and response json shall be identical with “create user” api call.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
 "email" : "newuser@allplan.com",
 "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": "newuser@allplan.com",
    "status": "Active",
    "firstname": "",
    "lastname": "",
    "company": "",
    "displayname": "",
    "info": "",
    "gender": "",
    "phoneWork": "",
    "phoneHome": "",
    "fax": "",
    "mobile": "",
    "birthDate": "",
    "address": {
        "street": "",
        "streetNr": "",
        "zip": "",
        "city": "",
        "country": ""
    },
    "preferedLanguage": ""
}

Anchor
getInvitations
getInvitations

Get all pending invitations
Deck of Cards
idbimGetInvitations
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: <teamslug>/invitations

URL: https://api-stage.bimplus.net/v2/<teamslug>/invitations

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

Card
labelHTTP Method
 GET
Card
labelDescription
 Get information about all pending invitations. Response returns list of all ( pending ) invitations.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
 [
  {
    "id": "55896fad-187e-47da-bdb6-b441607e3de3",
    "email": "newuser@allplan.com",
    "sender": {
      "id": "b664c6d9-d8ab-4257-88b0-d38588d979dc",
      "email": "testadmin@allplan.com",
      "firstname": "Test",
      "lastname": "Admin"
    },
    "team": {
      "id": "d7a504fe-b2ef-4847-bf79-d3733d93e478",
      "slug": "testteam",
      "name": "Test Team"
    },
    "invitationText": "Some text",
    "created": "2016-12-01T07:51:20.843",
    "changed": "2016-12-01T07:51:20.843",
    "validTo": "2016-12-08T07:51:20.843",
    "projects": [
      {
        "projectId": "e3921c6a-6329-441a-a715-e6c818e05043",
        "roleId": "2baca0e4-2eee-4f7c-bc56-22ed54a1859c"
      }
    ]
  }
]