Error Report

Tags:  

Error Report


1. Error in the input XML tags


If the input XML tags in the method call are not properly structured or the tags are not closed as specified an exception will occur with the message - 'Please provide a proper structured input'. The response is shown below:


<methodResponse>

<error>
<errorCode>1400</errorCode>
<message>Please provide a proper structured input.</message>
</error>

</methodResponse>


2. Error if in the input is not an XML

If the method call itself is not written in proper XML such as tags left open/type mismatch etc., the following exception is thrown:


<methodResponse>

<error>
<errorCode>1400</errorCode>
<message>
Error occured while parsing the uri null, at line 1
The element type "<struct>" must be terminated by the matching end-tag "</struct>".
</message>
</error>

</methodResponse>


3. Error if the method name is incorrect

If the method name being called is incorrect the following error message is generated: "Method Not Allowed".


<methodResponse>

<error>
<errorCode>1405</errorCode>
<message>No Such Method</message>
<info>
<methodName>"+methodname+"</methodName>
</info>
</error>

</methodResponse>

 
4. Error if the input for the requested method is empty

If the input during the method call is empty or not properly specified an exception is thrown.


<methodResponse>

<error>
<errorCode>1832</errorCode>
<message>Missing Argument</message>
</error>

</methodResponse>


5. Error if the input value is out of range

If the requested list of documents in the given range does not match the existing list of documents(owned, shared or trashed) in Zoho Writer we get this exception. For example in the shared documents folder we have 5 documents & the fromindex value is 6 with noofdocstoshow as 4. In this case the fromindex value is out of range as there is no 6th document in the shared folder, hence the exception.


<methodResponse>

<error>
<errorCode>1416</errorCode>
<message>Requested Range Not Satisfied</message>
<info>
<value><int>"+number+"</int></value>
</info>
</error>

</methodResponse>


6. Error if there is no document in the list

If the method call is to get the list of document in the owned/shared folder & there are no documents in that particular folder, we get an error message as a response.


<methodResponse>

<error>
<errorCode>1806</errorCode>
<message>Not Found, No documents in the shared list</message>
<info>
<documentid>"+docid+"</documentid>
</info>
</error>

</methodResponse>


7. Error if a document already Trashed is again specified in View, Save or Trash Method

If a document that is trashed is being called in any of the view/save/trash methods we get an exception with the message: "The document is already trashed".


<methodResponse>

<error>
<errorCode>1807</errorCode>
<message>The document is already trashed</message>
<info>
<documentid>"+docid+"</documentid>
</info>
</error>

</methodResponse>


8. Error if an unknown document specified in View, Save, Trash or Delete Method

If a document that is called by any of the view/save/trash/delete methods which does not exist an error is reported.



<methodResponse>

<error>
<errorCode>1404</errorCode>
<message>Document Not Found</message>
<info>
<documentid>"+docid+"</documentid>
</info>
</error>

</methodResponse>


9. Error if the image is not properly encoded

If an image to be uploaded in the document is not properly encoded we get an error report. The image should be encoded using base64encoding before passing into the xml content tag.


<methodResponse>

<error>
<errorCode>1500</errorCode>
<message>Unsupported Media Type, Upload Failed. Please try again with a proper input</message>
<info>
<image_encode>use base64encoding technique<image_encode>
</info>
</error>

</methodResponse>


10. Error if an image name starts with a number

If an image name starts with a number, an exception is thrown. It should always start with character.


<methodResponse>

<error>
<errorCode>1802</errorCode>
<message>The image name should not start with a number</message>
<info>
<image_name>"Should start with a character"</image_name>
</info>
</error>

</methodResponse>


11. Error if an image type is not specified

If an image type(eg. jpg, gif etc.) is not specified in the <contenttype> xml tag we get an error message. Below is the code snippet:


<methodResponse>

<error>
<errorCode>1803</errorCode>
<message>Please specify the content type</message>
<info>
<image_type>jpg/gif</image_type>
</info>
</error>

</methodResponse>


12. Error if a tag name already exist for the document

If a document is being tagged with the same name with which the document had been tagged earlier we get an exception.


<methodResponse>

<error>
<errorCode>1810</errorCode>
<message>Tag name already exists for the particular document</message>
<info>
<documentid>6000000006573</documentid>
<tag_name>zoho</tag_name>
</info>
</error>

</methodResponse>


13. Error if a tag name is added to a non-existing document

If we add a tag to the document that does not exist in the document list, an exception is thrown. A similar error report is generated when we try to delete a tag from a nonexistent document.


<methodResponse>

<error>
<errorCode>1804</errorCode>
<message>Not Found. No such document exists.</message>
<info>
<documentid>"+docid+"</documentid>
</info>
</error>

</methodResponse>


14. Error if trying to get a list of documents with an unknown tag name

If we try to retrieve a list of documents with the tag name that does not exist, an exception is thrown.


<methodResponse>

<error>
<errorCode>1804</errorCode>
<message>Not Found. No such tagname exists</message>
<info>
<tag_name>"+tagname+"</tag_name>
</info>
</error>

</methodResponse>



 

 RSS of this page