Page History

Info
This page is under construction

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)

Anchor

	createSetting
	createSetting

Create a new setting for the user

Deck of Cards

id	bimCreateSetting

Card

label	URL / Resource / JSON Structure

Resource: application/settings

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

Card

label	HTTP Method

POST

Card

default	true
label	Description

Creates a new setting for the user.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "key" : "UseBrowserCache",
    "value" : "yes"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
  "key": "UseBrowserCache",
  "value": "yes",
  "updated": "2015-07-23T09:43:46.1874953+02:00",
  "id": "30fb3b08-28f1-4878-b494-22acefb78f26"
}

Anchor

	getSettingList
	getSettingList

...

Get info about a setting

Deck of Cards

id	bimGetPinDetailsbimGetSettingInfo

Card

default	true
label	URL / Resource / JSON Structure

Resource: application/settings/<setting_id>

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

Card

label	HTTP Method

GET

Card

label	Description

Get details of a specified pinuser setting.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

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",
    "topologyNodeIdkey": "387fa6cc-b6f9-4470-8c42-c07982aba660AutoLoadLastModel",
     "position": {
        "xvalue": 123.45,
        "y": 234.56"Yes",
        "z": 345.67
    },
    "normalVectorupdated": {
        "x": 0,
        "y": 1,
        "z": 2
    },
    "createdAt": "2013-06-07T10:07:00",
    " "2015-08-19T00:04:16.387",
        "id": "8836308dc47b737c-f09f6727-4bb74832-b6d2bcd1-354a2db205a657ead714ae34"
}

Anchor

	updateSetting
	updateSetting

...

Deck of Cards

id	bimPinUpdate

Card

default	true
label	URL / Resource / JSON Structure

Resource: pins application/settings/<pin<setting_id> id>

URL: https://api-stage.bimplus.net/v2/<team_slug>application/pinssettings/<pin<setting_id>

Example: https://api-stage.bimplus.net/v2/bimplusapplication/pinssettings/8836308dc47b737c-f09f6727-4bb74832-b6d2bcd1-354a2db205a657ead714ae34

JSON Structure:

createdAtCreation pin

Name	Mandatory / Optional	Type	Description
issueIdidmandatory	will be ignored	string (guid)	The id Name 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)
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

Card

label	HTTP Method

PUT

Card

label	Description

Update or replace a specified existing pin with a new onethe value of a setting.

Card

label	Request

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",
    "objectIdkey": "7cf910cb-e357-43f6-aa3a-b45c26380f75AutoLoadLastModel",
    "position": {
        "xvalue": 123.45,
        "y": 234.56,
        "z": 345.67
    },
    "normalVector": {
        "x": 0,
        "y": 1,
        "z": 2
    }
No"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Delete a setting

Deck of Cards

id	bimDeletePinbimDeleteSetting

Card

default	true
label	URL / Resource / JSON Structure

Resource: pins application/settings/<pin<setting_id> id>

URL: https://api-stage.bimplus.net/v2/<team_slug>application/pinssettings/<pin<setting_id>

Example: https://api-stage.bimplus.net/v2/bimplusapplication/pinssettings/8836308dc47b737c-f09f6727-4bb74832-b6d2bcd1-354a2db205a657ead714ae34

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified pin.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 5

New Version 6

Key

User Settings Service

Create a new setting for the user

Get info about a setting

Delete a setting