System - Get general properties

API Url

Used for loading general portal/mobile properties.

GET

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

Permissions: user

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
properties	Object[]	Collection of general properties.
id	String	Property unique identifier.
locked	Boolean	true = Property is read-only.
name	String	Name of property.
type	Number	Type of property.
value	String	Value of property.
visible	Boolean	true = Property is visible to the user.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example:

HTTP/1.1 200 OK
{
   "response": {
      "data": {
          "properties": [
               {
                  "id": "DefTerm",
                  "name": "Terminal ID",
                  "value": "5000",
                  "type": 1,
                  "visible": false,
                  "locked": true
               },
               {
                  "id": "expandSingleWebpart",
                  "name": "Expand height for single web-parts",
                  "value": "FALSE",
                  "type": 2,
                  "visible": true,
                  "locked": false
               }
           ]
      },
      "errorCode": 0,
      "errorMessage": ""
   }
}

Error 4xx

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