Service Result Object

Ingeniux CMS Web Services API

All Ingeniux CMS Web Services API operations results use the same structure.

Web Service Operation Result Object

All Web Service API use the same wrapper object to return operation results.

The all services result use the following format:

JavaScript
Successful Operation Result:

{
    "code": 0,
    "error": null,
    "message": [actual operation result]
}

Failure Operation Result:

{
    "code": 2, 
    "error": "error message from operation",
    "message": null
}

Operation result code values:

Code

Response State

0

Successful

1

Session Expired / Requires Authentication

2

Error occurred in the operation

3

Cancelled by User

For details, please refer to:

XHRServiceResponseGenericT

See Also

Reference