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)
Create a new setting for the user
URL: https://api-stage.bimplus.net/v2/application/settings
Example: https://api-stage.bimplus.net/v2/application/settings
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
id |
will be ignored |
string |
Name of the project |
key |
mandatory |
string |
Key(i.e name) of the setting. It should be unique. |
value |
optional |
string |
Value for the key |
| update | will be ignored | string(date) | The update date of the setting |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"key" : "UseBrowserCache",
"value" : "yes"
}
Status: 201 Created
{
"key": "UseBrowserCache",
"value": "yes",
"updated": "2015-07-23T09:43:46.187",
"id": "30fb3b08-28f1-4878-b494-22acefb78f26"
}
Get the list of pre-defined user settings
URL: https://api-stage.bimplus.net/v2/application/settings
Example:https://api-stage.bimplus.net/v2/application/settings
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"key": "AutoLoadLastModel",
"value": "Yes",
"updated": "2015-08-19T00:04:16.387",
"id": "c47b737c-6727-4832-bcd1-57ead714ae34"
},
{
"key": "AutoProjectReordering",
"value": "Yes",
"updated": "2015-08-19T00:04:16.403",
"id": "f148d6be-b62e-467e-8584-274c8befa5c7"
},
{
"key": "BrowserType",
"value": "32",
"updated": "2015-08-19T00:04:16.43",
"id": "8b843b7d-c99d-4cf1-882d-dac7f502d28d"
},
{
"key": "DateFormat",
"value": "dd.mm.yy",
"updated": "2015-08-19T00:04:16.443",
"id": "74c47450-164c-4c83-adf6-32d349cff857"
},
{
"key": "DefaultOpacity",
"value": "0.5",
"updated": "2015-08-19T00:04:16.44",
"id": "fddfbbff-5812-4b94-9027-a3c17559096a"
},
{
"key": "Notifications",
"value": "Yes",
"updated": "2015-08-19T00:04:16.36",
"id": "177ae6e5-f02b-44ed-a516-c22264d264b2"
},
{
"key": "NotificationType",
"value": "Email,Browser",
"updated": "2015-08-19T00:04:16.38",
"id": "5599c2c3-d502-4fe8-8626-c6d0616fe888"
},
{
"key": "PinFlyToDistance",
"value": "20000",
"updated": "2015-08-19T00:04:16.433",
"id": "159f69e6-d952-4b86-aac2-5fed7e59b25a"
},
{
"key": "PinSize",
"value": "2",
"updated": "2015-08-19T00:04:16.39",
"id": "a726ffe3-3341-47e6-8ae2-a255a306c658"
},
{
"key": "ProjectOrderRule",
"value": "lastOpened",
"updated": "2015-08-19T00:04:16.423",
"id": "de286dcb-86c2-4279-9bd3-3e586dcae8d8"
},
{
"key": "SlideDelay",
"value": "3",
"updated": "2015-08-19T00:04:16.397",
"id": "d97f3810-e50d-48b3-b57f-a6cd182c2788"
},
{
"key": "StatusHideDelay",
"value": "5",
"updated": "2015-08-19T00:04:16.4",
"id": "8a84d9ad-13fb-4529-8dd4-2700f06870b4"
}
]
Get info about a setting
URL: https://api-stage.bimplus.net/v2/application/settings/<setting_id>
Example:https://api-stage.bimplus.net/v2/application/settings/c47b737c-6727-4832-bcd1-57ead714ae34
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"key": "AutoLoadLastModel",
"value": "Yes",
"updated": "2015-02-08T13:37:12.49",
"id": "c47b737c-6727-4832-bcd1-57ead714ae34"
}
Update a setting
URL: https://api-stage.bimplus.net/v2/application/settings/<setting_id>
Example:https://api-stage.bimplus.net/v2/application/settings/c47b737c-6727-4832-bcd1-57ead714ae34
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
id |
will be ignored |
string |
Name of the project |
key |
optional |
string |
Key(i.e name) of the setting. It should be unique. |
value |
optional |
string |
Value for the key |
| update | will be ignored | string(date) | The update date of the setting |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"key": "AutoLoadLastModel",
"value": "No"
}
Status: 200 OK
{
"key": "AutoLoadLastModel",
"value": "No",
"updated": "2015-07-23T09:43:46.187",
"id": "30fb3b08-28f1-4878-b494-22acefb78f26"
}
Delete a setting
URL: https://api-stage.bimplus.net/v2/application/settings/<setting_id>
Example:https://api-stage.bimplus.net/v2/application/settings/c47b737c-6727-4832-bcd1-57ead714ae34
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
