Versions Compared

Old Version 8

changes.mady.by.user Milan Kristof

Saved on

compared with

New Version 9

changes.mady.by.user Peter Benke

Saved on

Key

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

...

Deck of Cards
idbimCreateInvitation
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: <teamslug>/invitations 

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

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

JSON Structure:

Name

Mandatory / Optional

Type

Description

email

mandatory

string

Email of the new user

invitationTextmandatoryoptionalstringMessage text for an invited user
projectsoptionalobjectList of objects which contains pairs of project id with role id the new user is invited to.
Property in the request is optional. If not present, it means that the invitation is just to the team.

status

optional

will be ignored

The status of the account (Active / Disabled)

sender

optional

string

The sender must have a valid Bimplus account and must be member of the team

teamoptionalstringTeam for which the invitation is valid
teamRoleoptionalstringTeam role is optional. If missing default is team member role
statusoptionalstringInvitation status
validTooptionaldateDate the invitation is valid to
createdoptional

date

Creation date of the invitation

changedoptionaldateRecent modification date of the invitation
counteroptionalstringHome phone number of the user
Card
labelHTTP Method
 POST
Card
labelDescription
 Creates and sends a new invitation to the new user.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
  "email":"newuser@allplan.com",
  "invitationText":"Some text",
  "projects":[{
      "projectId":"e3921c6a-6329-441a-a715-e6c818e05043",
      "roleId":"2baca0e4-2eee-4f7c-bc56-22ed54a1859c"
    }
  ]
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created
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"
  },
  "teamRole":"d9946cc8-8bd0-4eae-aeb1-d27b310741d7",
  "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"
    }
  ]
}

...