Skip to content

Latest commit

 

History

History
76 lines (58 loc) · 2.67 KB

_index.md

File metadata and controls

76 lines (58 loc) · 2.67 KB
id url title productName weight description keywords toc
getting-started
viewer/getting-started
Getting Started
GroupDocs.Viewer Cloud
1
This section introduces GroupDocs.Viewer Cloud specific Resources & Operations.
groupdocs.viewer cloud, getting started
true

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 is 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.
Code Description
200 The request has succeeded.
201 The request has been fulfilled and resulted in a new resource being created.
204 The request has been fulfilled and resource(s) were removed.
400 Failed to handle the request due to invalid parameters or missing resources.
401 Authorization failed.
404 The Requested resource was not found.
405 The Requested method is not allowed.
500 Internal 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 Code Status Code Description
FileNotFound Not Found (404) Indicates that the file was not found.
AttachmentNotFound Not Found (404) Indicates that the attachment was not found.
FontsPathNotFound Not Found (404) It Indicates that the specified fonts path can not be found.
MissingPassword Forbidden (403) Indicates that the password was not provided to open the document.
IncorrectPassword Forbidden (403) It indicates that the provided password is incorrect.
FailedToReadFile Bad Request (400) It Indicates that the Viewer could not read the file. The File can be corrupted or damaged.
UnsupportedFileType Bad Request (400) This indicates that the provided file has a format that is not supported.
MissingFileInfo Bad Request (400) This indicates that the parameter 'FileInfo' was not specified.
MissingParameters Bad Request (400) Indicates that request parameters missing or have the incorrect format.

Articles in this section