System - Update general properties

API Url

Used for updating general portal/mobile properties.

PUT

http://localhost:16010/ProMarkREST/rest/System/properties

Permissions: user

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
properties	Object[]	Collection of general properties.
id	String	Property unique identifier (not updatable).
locked	Boolean	true = Property is read-only (not updatable).
name	String	Name of property (not updatable).
type	Number	Type of property (not updatable).
value	String	Value of property.
visible	Boolean	true = Property is visible to the user (not updatable).

Request example:

{
   "request": {
      "data": {
          "properties": [
               {
                  "id": "DefTerm",
                  "name": "Terminal ID",
                  "value": "5000",
                  "type": 1,
                  "visible": true,
                  "locked": false
               }
           ]
      }
   }
}

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
errorCode	Number	Error code.
errorMessage	String	Error description.