Info |
---|
This page is under construction |
User Settings Service
...
- Create an user setting
- Get the list of pre-defined user settings
- Get info about a setting
- Update a setting
- Delete a setting
User Settings Service
...
User settings are used for configuring the settings that belongs to particular user. eg: Whether the user would like receive notifications or not, what type of notification, pin-size, model opacity etc., Please remember that the application_id has to be provided in the authentication request for using these services. Each combination of userId - applicationId is unique (which means the settings are relevant only to a particular application)
- Please use the Bimplus Issue Service for creating a pin or for getting/deleting all the pins assigned to an issue
Anchor |
---|
| getPinDetails |
---|
| getPinDetails |
---|
|
Get details of the pin
Deck of Cards |
---|
|
Card |
---|
| Get details of a specified pin. |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
"objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"topologyNodeId": "387fa6cc-b6f9-4470-8c42-c07982aba660",
"position": {
"x": 123.45,
"y": 234.56,
"z": 345.67
},
"normalVector": {
"x": 0,
"y": 1,
"z": 2
},
"createdAt": "2013-06-07T10:07:00",
"id": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
}
|
|
|
Update the pin
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: pins/<pin_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/pins/<pin_id> Example: https://api-stage.bimplus.net/v2/bimplus/pins/8836308d-f09f-4bb7-b6d2-354a2db205a6 JSON Structure: Name | Mandatory / Optional | Type | Description |
---|
issueId | mandatory | string (guid) | The id of the issue to which the pin is related | objectId | mandatory | string (guid) | The id of the object to which the pin is related | newObjectId | optional | string (guid) | It should be specified when the pin is assigned to another object via update | topologyNodeId | optional | string (guid) | The id of the topology to which the pin is attached | position | optional | object | The position of the issue in the building (x,y,z co-ordinates) | normalVector | optional | object | The direction of the issue in the 3D space (x,y,z co-ordinates) | createdAt | will be ignored | date | Creation date of the pin |
|
Card |
---|
| Update or replace a specified existing pin with a new one. |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
"objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"position": {
"x": 123.45,
"y": 234.56,
"z": 345.67
},
"normalVector": {
"x": 0,
"y": 1,
"z": 2
}
}
|
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
|
|
Delete the pin
Deck of Cards |
---|
|
Card |
---|
| Deletes a specified pin. |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
|
|