Response Data Types
Response data types are represented in XML format. This allows for more complex object types to be represented in the response data.
The following response types are possible in addition to the basic types defined for request data types (Boolean, Integer, String, TimeStamp).
Each complex type is represented as an XML element, with properties represented as sub-elements. XML element names always use camelCase notation (first character is lower case).
Versions
The table below lists Response data types in relation to the WebAPI and Zend Server versions they became available for.
Note:
The table does not display information regarding changes made to existing Response data types. This information is displayed on the specific method page.
|
Response Type |
WebAPI / Zend Server |
||||||||
|
1.0/ 5.1 |
1.1/5.5 |
1.2/5.6 |
1.3/6.0 |
1.5/6.1 | 1.6/6.2 | 1.7/6.3 | 1.8/7.0 | 1.9/8.0* | |
| directive |
|
|
|
|
|
|
|
|
|
| extension |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| messageList |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| serverData |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| servers |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| issueGeneralDetails |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| jobqueueStatistics |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| debugRequest |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| licenseChange |
|
|
|
|
|
|
|
|
|
| currentLicense and newLicense |
|
|
|
|
|
|
|
|
|
| serverComplete |
|
|
|
|
|
|
|
|
|
| tasksPerServer |
|
|
|
|
|
|
|
|
|
| libraryList |
|
|
|
|
|
|
|
|
|
| libraryInfo |
|
|
|
|
|
|
|
|
|
| libraryVersion |
|
|
|
|
|
|
|
|
|
| libraryServer |
|
|
|
|
|
|
|
|
|
| prerequisitesCheck |
|
|
|
|
|
|
|
|
|
| daemonMessage |
|
|
|
|
|
|
|
|
|
| daemonMessages |
|
|
|
|
|
|
|
|
|
| vhostDetails |
|
|
|
|
|
|
|
|
|
| vhostInfo |
|
|
|
|
|
|
|
|
|
| vhostServer |
|
|
|
|
|
|
|
|
|
| vhostExtended |
|
|
|
|
|
|
|
|
|
| vhostApplications |
|
|
|
|
|
|
|
|
|
| vhostApplication |
|
|
|
|
|
|
|
|
|
| validation |
|
|
|
|
|
|
|
|
|
| bootstrap |
|
|
|
|
|
|
|
|
|
| apiKey |
|
|
|
|
|
|
|
|
|
| requestsList |
|
|
|
|
|
|
|
|
|
| request |
|
|
|
|
|
|
|
|
|
| requestInfo |
|
|
|
|
|
|
|
|
|
| requestLogEntries |
|
|
|
|
|
|
|
|
|
| requestSqlQueries |
|
|
|
|
|
|
|
|
|
| logEntry |
|
|
|
|
|
|
|
|
|
| exception |
|
|
|
|
|
|
|
|
|
| backtraceRow |
|
|
|
|
|
|
|
|
|
| functionStats |
|
|
|
|
|
|
|
|
|
| requestRuntime |
|
|
|
|
|
|
|
|
|
| requestEnvironment |
|
|
|
|
|
|
|
|
|
| parameters |
|
|
|
|
|
|
|
|
|
| parameterMap |
|
|
|
|
|
|
|
|
|
| accessToken |
|
|
|
|
|
|
|
|
|
| urlinsightUrlsList |
|
|
|
|
|
|
|
|
|
| urlinsightUrl |
|
|
|
|
|
|
|
|
|
| urlinsightRequestInfo |
|
|
|
|
|
|
|
|
|
*Current version
