System - Get web-parts catalog

API Url

Used for loading a list (catalog) with web-parts that can be added to any tab menu. Only web-parts that are enabled will be returned!

GET

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

Permissions: user

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
webpartsCatalog	Object[]	Collection of web-parts.
enabled	Boolean	true = Web-part is usable.
locked	Boolean	true = Web-part is locked.
name	String	Name of the web-part.
type	Number	Web-part type.
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": {
         "webpartsCatalog": [
            {
               "type": 1,
               "name": "Registration",
               "enabled": 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.