Response object members

05/26/2022 Contributors

PDFs

Each Element software API response body has the following basic parts:

Name	Description	Type
result	The object returned by the method. The system returns an object with named members corresponding to the documented return value for the method. This member is not present if an error has occurred.	JSON object
error	The object returned when an error occurs. This member is present only if an error has occurred.	Object
id	An identifier used to match the request to response, as provided in the request.	string or integer
unusedParameters	A warning message that at least one incorrect parameter has been passed to the API method and has not been used.	Object

Name

Description

Type

result

The object returned by the method. The system returns an object with named members corresponding to the documented return value for the method. This member is not present if an error has occurred.

JSON object

error

The object returned when an error occurs. This member is present only if an error has occurred.

Object

An identifier used to match the request to response, as provided in the request.

string or integer

unusedParameters

A warning message that at least one incorrect parameter has been passed to the API method and has not been used.

Object

Response object members

Creating your file...