...
Please remember that creating/updating/deleting an user is possible only for the clients who has the permission to do it.
Create a new user
| Deck of Cards |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| | Resource: users URL: https://api-stage.bimplus.net/v2/users Example: https://api-stage.bimplus.net/v2/users JSON Structure: Name | Mandatory / Optional | Type | Description |
|---|
email | mandatory | string | Email of the user | status | optional | will be ignored | The status of the account (Active / Inactive) | password | mandatory | string | Password of the user | | firstname | optional | string | First name of the user | | lastname | optional | string | Last name of the user | | company | optional | string | Company of the user | | displayname | optional | string | Display name of the user | | info | optional | string | Information of the user | | gender | optional | string | Gender of the user | | phoneWork | optional | string | Office phone number of the user | | phoneHome | optional | string | Home phone number of the user | | fax | optional | string | Fax number of the user | | mobile | optional | string | Mobile number of the user | | birthDate | optional | string | Birth date of the user | | address | optional | object | Address of the user | | street | optional | string | Street name of the user | | streetNr | optional | string | Street number of the user | | zip | optional | string | Zip code | | city | optional | string | City name of the user | | country | optional | string | Country name of the user | | preferredLanguage | optional | string | Preferred language of the user (will be set in the portal) | | teams | will be ignored | array | Team list of the user | | team | will be ignored | object | Information about an user's team (See the team service) | | projects | will be ignored | array | Project list of the user | | project | will be ignored | object | Information about an user's project (See the project service) |
|
| Card |
|---|
| | Creates a new user account. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal) |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Headers |
|---|
| lang | xml |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block |
|---|
| borderColor | Red |
|---|
| title | JSON |
|---|
| lang | xml |
|---|
| {
"email" : "test@bimplus.net",
"password" : "test"
}
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Status |
|---|
| lang | xml |
|---|
| Status: 201 Created
|
| Code Block |
|---|
| borderColor | Red |
|---|
| title | JSON |
|---|
| lang | xml |
|---|
| {
"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": ""
}
|
|
|
...
Please remember that creating/updating/deleting a team is possible only for the clients who has the permission to do it.
Create a new team and its related database
...
| Anchor |
|---|
| addUserToTeam |
|---|
| addUserToTeam |
|---|
|
Please remember that the team owner cannot remove the membership from his own team.
Add the user to the team
| Deck of Cards |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| | Resource: <team_slug>/members URL: https://api-stage.bimplus.net/v2/<team_slug>/members Example: https://api-stage.bimplus.net/v2/best-company/members JSON Structure: Name | Mandatory / Optional | Type | Description |
|---|
user | mandatory | object | Information of the user | user.id | mandatory | string | Id of the user | user.email | will be ignored | string | Email of the user | user.status | will be ignored | string | Status of the user(Active / Inactive) | roles | will be ignored | object | Roles of the user | member_status | optional | string | Status of the membership(Active / Passive) |
|
| Card |
|---|
| | Add a specified user to a specified team. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Headers |
|---|
| lang | xml |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block |
|---|
| borderColor | Red |
|---|
| title | JSON |
|---|
| lang | xml |
|---|
| {
"user": {
"id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6"
},
"roles": [
"Member"
],
"member_status": "Active"
}
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Status |
|---|
| lang | xml |
|---|
| Status: 200 Ok
|
|
|
...