Skip to end of metadata
Go to start of metadata

Getting Started

Overview

This section introduces GroupDocs.Viewer Cloud specific Resources & Operations.

Base URI

In the rest of documentation base URI presented as '~' character.

Input&Output Format

GroupDocs.Viewer cloud supports request body data and response data formatted as JSON.

Errors

GroupDocs.Viewer Cloud API performs communication errors by using HTTP Status Codes with details passed in JSON or XML objects.

The main patterns are:
2xx - The request was recieved and accepted.
4xx - Error occured while processing the request. Invalid parameter or missing file can cause this error.
5xx - The request was recieved and accepted, but an error occured in the GroupDocs.Viewer Cloud service while processing it.

HTTP Status Codes
CodeDescription
200The request has succeeded.
201The request has been fulfilled and resulted in a new resource being created.
204The request has been fulfilled and resource(s) were removed.
400Failed to handle the request due to invalid parameter or missing resource.
401Authorization failed.
404Requested resource was not found.
405Requested method is not allowed.
500Internal serverver error occured while processing the request.
Example Error Response
Error Codes
Error CodeStatus CodeDescription
FileNotFoundNot Found (404) Indicates that the file was not found. 
AttachmentNotFound Not Found (404) Indicates that the attachment was not found. 
FontsPathNotFoundNot Found (404) Indicates that specified fonts path can not be found.
MissingPassword Forbidden (403)Indicates that the password was not provided to open document. 
IncorrectPasswordForbidden (403) Indicates that the provided password is incorrect. 
FailedToReadFile Bad Request (400) Indicates that the Viewer could not read the file. File can be corrupted or damaged. 
UnsupportedFileType Bad Request (400) Indicates that the provided file has format which is not supported. 
MissingFileInfoBad Request (400) Indicates that parameter 'FileInfo' was not specified.
MissingParametersBad Request (400)Indicates that request parameters missing or have incorrect format.

 

Contents:

 

Labels
  • No labels