System - Get tabs

API Url

Used for loading portal/mobile (depending on X-Client) tabs containing web-parts.

GET

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

Permissions: user

Query parameters

Field	Type	Description
extend`optional`	String	webparts = Include child web-parts collection in response.
visible`optional`	Boolean	true = Get only visible tabs.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
tabs	Object[]	Collection of tabs.
id	Number	Tab identifier.
name	String	Name of the tab.
visible	Boolean	true = Tab is visible on the user.
webparts`optional`	Object[]	Collection of web-parts.
id	Int64	Web-part unique identifier.
name	String	Name of the web-part.
order	Number	Order sequence inside the zone (used for layout).
properties`optional`	Object[]	Collection of web-part properties.
id	String	Property unique identifier.
locked	Boolean	true = Web-part property is read-only.
name	String	Name of property.
type	Number	Type of property.
value	String	Value of property.
visible	Boolean	true = Web-part property is visible to the user.
tabId	Number	Tab identifier.
type	Number	Web-part type.
zone	Number	Zone identifier (used for layout).
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": {
         "tabs": [
            {
               "id": 1,
               "name": "Personal",
               "iconId": "delete",
               "visible": true
            }
         ]
      },
      "errorCode": 0,
      "errorMessage": ""
   }
}

Success example when extend=webparts:

HTTP/1.1 200 OK
{
   "response": {
      "data": {
         "tabs": [
            {
               "id": 1,
               "name": "Personal",
               "visible": true,
               "webparts": [
                  {
                    "id": 409,
                    "type": 1,
                    "name": "Registration",
                    "tabId": 1,
                    "zone": 1,
                    "order": 1
                  },
                  {
                    "id": 410,
                    "type": 2,
                    "name": "Attendance overview",
                    "tabId": 1,
                    "zone": 2,
                    "order": 1,
                    "properties": [
                        {
                           "id": "ActDeptDes",
                           "name": "Show actual department description",
                           "value": "FALSE",
                           "type": 2,
                           "visible": true,
                           "locked": false
                        },
                        {
                           "id": "ActDeptId",
                           "name": "Show act department ID",
                           "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.