Page History

...

Deck of Cards

id	bimCreateInvitation

Card

default	true
label	URL / 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
invitationText	mandatoryoptional	string	Message text for an invited user
projects	optional	object	List of objects which contains pairs of project id with id, role id, group id and role id of group where 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
team	optional	string	Team for which the invitation is valid
teamRole	optional	string	Team role is optional. If missing default is team member role
status	optional	string	Invitation status
validTo	optional	date	Date the invitation is valid to
created	optional	date	Creation date of the invitation
changed	optional	date	Recent modification date of the invitation
counter	optional	string	Home phone number of the user

Card

label	HTTP Method

POST

Card

label	Description

Creates and sends a new invitation to the new user.

JSON Structure of the projects object :

Name	Mandatory / Optional	Type	Description
projectId	mandatory	string (guid)	The id of the project where the new user is invited to.
roleId	mandatory	string (guid)	The role id for new user.
group	optional	Object	Object which contains pairs of group's id and group's role where the new user is invited to.

Card

label	HTTP Method

POST

Card

label	Description

Creates and sends a new invitation to the new user.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
  	"email": "newuser@allplan.com",
  	"invitationText": "Some text",
  	"projects": [{
      			"projectId": "e3921c6a-6329-441a-a715-e6c818e05043",
      			"roleId": "2baca0e4-2eee-4f7c-bc56-22ed54a1859c",
    }
  ]
}
			"group": {
				"id": "51edc181-b228-4f9e-aa3d-0a30f64695b4",
				"role": "da3c04d7-b593-4017-b6c3-4c9eed7699bb"
			}
		}
	]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
  	"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",
    }
  			"group": {
				"id": "51edc181-b228-4f9e-aa3d-0a30f64695b4",
				"role": "da3c04d7-b593-4017-b6c3-4c9eed7699bb"
			}
		}
	]
}

Anchor

	getInvitation
	getInvitation

...

Deck of Cards

id	bimGetInvitation

Card

default	true
label	URL / Resource / JSON Structure

Resource: <teamslug>/invitations/<invitation_id>

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

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

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified invitation.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

 {
  	"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",
 			"group": {
  }
  ]
}				"id": "51edc181-b228-4f9e-aa3d-0a30f64695b4",
 				"role": "da3c04d7-b593-4017-b6c3-4c9eed7699bb"
 			}
 		}
 	]
 }

Anchor

	updateInvitation
	updateInvitation

...

Deck of Cards

id	bimUpdateInvitation

Card

default	true
label	URL / Resource / JSON Structure

Resource: <teamslug>/invitations/<invitation_id>

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
email	mandatory	string	Email of the new user
invitationText	mandatory	string	Message text for an invited user
projects	optional	object	List of objects which contains pairs of project id role id, group id with , role id of group where 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
team	optional	string	Team for which the invitation is valid
teamRole	optional	string	Team role is optional. If missing default is team member role
status	optional	string	Invitation status
validTo	optional	date	Date the invitation is valid to
created	optional	date	Creation date of the invitation
changed	optional	date	Recent modification date of the invitation
counter	optional	string	Home phone number of the user

Card

label	HTTP Method

PUT

Card

label	Description

Update invitation information to the new user. Only the Sender is able to Update and Resend the invitation to the new user.
The invitation might change the invitation text and projects.

JSON Structure of the projects object :

Name	Mandatory / Optional	Type	Description
projectId	mandatory	string (guid)	The id of the project where the new user is invited to.
roleId	mandatory	string (guid)	The role id for new user.
group	optional	Object	Object which contains pairs of group's id and group's role where the new user is invited to.

Card

label	HTTP Method

PUT

Card

label	Description

Update invitation information to the new user. Only the Sender is able to Update and Resend the invitation to the new user.
The invitation might change the invitation text and projects.

Card

label	Request

Code Block

borderColor	Green

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSONHeaders

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
	"invitationText": "Some  "invitationText":"Some text",
  	"projects": [{
      			"projectId": "e3921c6a-6329-441a-a715-e6c818e05043",
      			"roleId": "2baca0e4-2eee-4f7c-bc56-22ed54a1859c"
    }
  ,
			"group": {
				"id": "51edc181-b228-4f9e-aa3d-0a30f64695b4",
				"role": "da3c04d7-b593-4017-b6c3-4c9eed7699bb"
			}
		}
	]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

title	JSON

 {
  "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",
	  "group": {
			"id": "51edc181-b228-4f9e-aa3d-0a30f64695b4",
			"role": "da3c04d7-b593-4017-b6c3-4c9eed7699bb"
		}
    }
  ]
}

Anchor
deleteInvitation
deleteInvitation

...

Deck of Cards

id	bimDeleteInvitation

Card

default	true
label	URL / Resource / JSON Structure

Resource: <teamslug>/invitations/<invitation_id>

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

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

Card

label	HTTP Method

DELETE

Card

label	Description

Delete a specified invitation for new user. Please remember that only the Sender is able to delete the invitation

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Accept invitation

 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor
acceptInvitation
acceptInvitation

Accept invitation

Deck of Cards

id	bimAcceptInvitation

Card

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

label	HTTP Method

PUT

Card

label	Description

Since this api call will create new user in Bimplus, the request and response json shall be identical with “create user” api call.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
 "email" : "newuser@allplan.com",
 "password" : "test"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

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

id	bimGetInvitations

Deck of Cards

id	bimAcceptInvitation

Card

default	true
label	URL / Resource / JSON Structure

Resource: <teamslug>/invitations/<invitation_id>/accept

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

Card

label	Description

Since this api call will create new user in Bimplus, the request and response json shall be identical with “create user” api call.

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

Card

label	HTTP Method

PUT

/bimplus/invitations

Card

label	RequestHTTP Method

code GETborderColor

Green

Card

label

lang

xml

title

Headers

Description

Get information about all pending invitations. Response returns list of all ( pending ) invitations.

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

Card

label	Request

Code Block

borderColor	RedGreen
lang	xml
title	JSONHeaders

{
 "email" : "newuser@allplan.com",
 "password" : "test"
}Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201200 CreatedOK

Code Block

borderColor	Red
lang	xml
title	JSON

[{
    "teams": [],
    "		"id": "b8615afc55896fad-99cc187e-4bcd47da-b0cabdb6-ff0593ce15c6b441607e3de3",
    		"email": "newuser@allplan.com",
    "status		"sender": {
			"id": "Activeb664c6d9-d8ab-4257-88b0-d38588d979dc",
    "firstname			"email": "testadmin@allplan.com",
    "lastname			"firstname": "Test",
    "company			"lastname": "Admin"
		},
    "displayname		"team": "",
    "info{
			"id": "d7a504fe-b2ef-4847-bf79-d3733d93e478",
    "gender			"slug": "testteam",
    "phoneWork			"name": "Test Team"
		},
    "phoneHome		"invitationText": "Some text",
    "fax		"created": "2016-12-01T07:51:20.843",
    "mobile": "",
    "birthDate": "",
    "address": {
        "street": "",
        "streetNr": "",
        "zip": "",
        "city": "",
        "country": ""
    },
    "preferedLanguage": ""
}
		"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",
				"group": {
					"id": "51edc181-b228-4f9e-aa3d-0a30f64695b4",
					"role": "da3c04d7-b593-4017-b6c3-4c9eed7699bb"
				}
			}
		]
	}
]

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 6

New Version Current

Key

Anchor
deleteInvitation
deleteInvitation

Accept invitation

Anchor
acceptInvitation
acceptInvitation

Accept invitation

Get all pending invitations

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 6

New Version Current

Key

AnchordeleteInvitationdeleteInvitation

Accept invitation

AnchoracceptInvitationacceptInvitation

Accept invitation

Get all pending invitations

Anchor
deleteInvitation
deleteInvitation

Anchor
acceptInvitation
acceptInvitation