Errors

Office Integrator APIs returns the error information in two levels:

  • HTTP error codes and messages in the header.
  • A JSON object in the response body with additional details that can help you determine how to handle the error.

JSON Object Syntax:

{
        "key_name": "document.exprt",
        "code": "1832"
        "parameter_name": "permissions"
        "message": "Error occurred. Parameter name is either incorrect or invalid."
}

 

FieldsDescription
messageAn error description.
codeA unique error code.
parameter_nameThe problematic parameter name will be returned. It will not be available in all cases.
key_nameThe key name which needs to be checked and modified inside the problematic parameter will be displayed.

The possible error codes of all the three services (Writer, Sheet and Show) are listed on the below links.