Getting Started

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

Base URI

https://api.groupdocs.cloud/v2.0/viewer/

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

Request & Response Format

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

Response Status Codes

  • 2xx - The request was received and accepted.
  • 4xx - Error occurred while processing the request. An invalid parameter or the missing file can cause this error.
  • 5xx - The request was received and accepted, but an error occurred in the GroupDocs.Viewer Cloud service while processing it.
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 parameters or missing resources.
401Authorization failed.
404The Requested resource was not found.
405The Requested method is not allowed.
500Internal server error occurred while processing the request.

Errors

GroupDocs.Viewer Cloud API returns errors by using HTTP Status Codes with details passed in response body.

Example Error Response

Status: 404 Not Found
{
  "error": {
    "code": "FileNotFound",
    "message": "Can't find file with given name 'document.doc' and folder 'My Documents'."
  }
}

Error Codes

Error CodeStatus CodeDescription
FileNotFoundNot Found (404)Indicates that the file was not found.
AttachmentNotFoundNot Found (404)Indicates that the attachment was not found.
FontsPathNotFoundNot Found (404)It Indicates that the specified fonts path can not be found.
MissingPasswordForbidden (403)Indicates that the password was not provided to open the document.
IncorrectPasswordForbidden (403)It indicates that the provided password is incorrect.
FailedToReadFileBad Request (400)It Indicates that the Viewer could not read the file. The File can be corrupted or damaged.
UnsupportedFileTypeBad Request (400)This indicates that the provided file has a format that is not supported.
MissingFileInfoBad Request (400)This indicates that the parameter ‘FileInfo’ was not specified.
MissingParametersBad Request (400)Indicates that request parameters missing or have the incorrect format.

Articles in this section