Zoho Remote API Update - Custom Save Notification Messages

Zoho Remote API Update - Custom Save Notification Messages

We are happy to announce that partners and developers, integrating Zoho's Remote API into their application, can now send a custom save notification message to Zoho document servers. The custom message will be displayed when a user saves the document from any of the Zoho's Office Productivity Service (Writer, Sheet, Show) editors.

Currently, Zoho handles both the scenarios of a document save and displays:
  1. Success Message (HTTP response code 200) - When the document is saved successfully.
  2. Error Message (HTTP response code 500) - When the document save fails. 
Partners and developers can send the customized save message to Zoho's document servers in the following format:

RESPONSE: [Success or Error message from the partner's application]

In the case of partner application failing to provide custom message of its own, Zoho will display its default save notification messages in the Service editors. The list of these messages is tabulated below:
Save Notification Messages
 Description
Save in Progress
 User clicks on Save button. A request for saving the document is initiated.
Document Saved Successfully Default notification message displayed by Zoho when a document is saved successfully in partner's application. 

This message will appear when Zoho receives only a HTTP response code 200 without any custom message from the partner's application. 
Document already saved
 No document modification detected. This message will appear in two cases:
  1. User hits the save button without modifying the contents of the original document.
  2. After getting the 'Document Saved Successfully' message, user inadvertently hits the save button without making any further edits to the document. 
<Partner application's customized success message>
 Custom save notification message displayed when a document is saved successfully.

This message is sent from the partner's application server with HTTP status code 200 and is of the format -RESPONSE: [Success message from the partner application]
<user name> has saved the Document
 In collaboration mode, Zoho notifies 'Document saved status' to other shared users.
Problem in saving content. Please retain a local copy at your end and try again later.
 The save notification, sent as response, to Zoho servers from the partner application either fails or is null. HTTP status code is other than 200.
Error in saving document from remote client side
 Document save fails. HTTP status code 500 returned to Zoho servers as a response with a custom message in the following format - RESPONSE: [Error message from the partner application]
Problem in saving complex document. Please retain a local copy at your end and try again later.
 This message is displayed when the user tries to save the document with null content into partner's application.
Problem in posting the document. Please retain a local copy at your end and try again later.
 Any error encountered while posting content to the partner's server via saveurl or remote agent method.
Document format not supported. Error in saving content
 Message displayed when the document content is saved in an unsupported format. 
Connection refused from the remote server
 Message displayed when the save response from the partner's application is timed out

Thanks,
Ahmed
http://api.zoho.com










      • Sticky Posts

      • Zoho Office Integrator: Moving to the all-new Zoho Sheet

        We introduced the latest version of Zoho Sheet—Sheet 5—in early 2019. This new version consists of a new user interface, improved performance, and an array of useful features. As a part of this, we will upgrade our Remote API integrations to the new version's editor interface on February 29, 2020. Update: The remote API integrations upgrade to the new version's interface will be done on April 15, 2020. Here are some exciting enhancements the new version of Sheet offers for our API users: An AI-powered

      • Businesses prefer Zoho Office Integrator over Microsoft WOPI - Here's why

        Businesses often have difficult decisions to make when building web applications that provide document management capabilities for their users. For example, what's the best solution to integrate with online office editors— Zoho Office Integrator or Microsoft