Structures.idl

Go to the documentation of this file.

/**
 * @file   Structures.idl
 * @brief  Data structures shared among webmail API.
 *
 * @author Dusan Juhas, Frantisek Boranek
 *
 * @copyright Copyright © 2017 Kerio Technologies s.r.o.
 *
 * @defgroup Common
 * @{
 */

#import <kerio/web/idl/SharedStructures.idl>
#import <common.idl>

module kerio {
module jsonapi {
module webmail {


const long ErrorCodeParseError        = -32700; // Parse error. Request wasn't valid JSON. (HTTP Status 500)
const long ErrorCodeInternalError     = -32603; // Internal error. (HTTP Status 500
const long ErrorCodeInvalidParams     = -32602; // Invalid params. (HTTP Status 500)
const long ErrorCodeMethodNotFound    = -32601; // Method not found.The requested method doesn't exist. (HTTP Status 404)
const long ErrorCodeInvalidRequest    = -32600; // Invalid request. (Too many files uploaded.etc.) (HTTP Status 500)

// -32099 to -32000 (Reserved for Kerio-defined server errors.)
const long ErrorCodeMultiServerBackendMaintenance = -32003; ///< Error generated on client side only
const long ErrorCodeTimedout                      = -32002; ///< Error generated on client side only
const long ErrorCodeSessionExpired                = -32001; ///< Session expired. (HTTP Status 500)

const long ErrorCodeCommunicationFailure  = -1;     ///< Error generated on client side only

// 1 to 999 (Reserved)
const long ErrorCodeRequestEntityTooLarge = 413; ///< The client tried to upload a file bigger than limit. (Generally any HTTP POST request, including JSON-RPC Request.)

// 1000 to 1999 (Reserved for Kerio-common errors)
const long  ErrorCodeOperationFailed     = 1000; ///< The command was accepted, the operation was run and returned an error.
const long  ErrorCodeAlreadyExists       = 1001; ///< Can't create the item, as it already exists.
const long  ErrorCodeNoSuchEntity        = 1002; ///< Message / folder / etc. doesn't exist.
const long  ErrorCodeNotPermitted        = 1003; ///< Server refused to proceed. E.g. Can't delete default folder.
const long  ErrorCodeAccessDenied        = 1004; ///< Insufficient privileges for the required operation.
// 4000 to 4999 (Reserved for Connect)
const long  ErrorCodeDangerousOperation  = 4000; ///< Operation is dangerous. Used for reporting in validation functions.
const long  ErrorCodePartialSuccess      = 4001; ///< Operation ended partial successful.
const long  ErrorCodeChangePswFailed     = 4002; ///< Failed to change your password. The new password was not accepted.

// 4100 to 4199 (Reserved for Connect/Webmail specific)
const long  ErrorCodeFolderReindexing    = 4100; ///< Folder is already being reindexed. Try later.
const long  ErrorCodeOperationInProgress = 4101; ///< Long lasting operation blocks perform the request. Try later.
const long  ErrorCodeQuotaReached        = 4102; ///< Items quota or disk size quota was reached.
const long  ErrorCodeSendingFailed       = 4103; ///< Failed to send email.
const long  ErrorCodeNoSuchFolder        = 4104; ///< Folder of given GUID doesn't exist.
const long  ErrorCodeOperatorSessionExpired = 4105; ///< Session to Operator expired.


typedef string UtcTime;     ///< Time according RFC 2445, eg. 070000Z means 07:00 AM
typedef longlong Watermark; ///< Max. 9007199254740992, min. -9007199254740992

enum PriorityType {
   Normal, ///< default value
   Low,
   High
};

enum ItemType {
   itMail,
   itCalendar,
   itContact,
   itTask,
   itNote,
   itCalendarInbox
};

/**
 * Details about a particular item created.
 */
struct CreateResult {
    long inputIndex;      ///< 0-based index to input array, e.g. 3 means that the relates to the 4th element of the input parameter array
   kerio::web::KId  id;  ///< ID of created item.
   Watermark watermark;  ///< item version from journal
};

typedef sequence<CreateResult> CreateResultList;

/**
 * Details about a particular item updated.
 */
struct SetResult {
    long inputIndex;      ///< 0-based index to input array, e.g. 3 means that the relates to the 4th element of the input parameter array
   kerio::web::KId  id;  ///< if not empty the item was moved and its ID was changed to this value
   Watermark watermark;  ///< item version from journal
};

typedef sequence<SetResult> SetResultList;

struct Image {
   string url; ///< [READ ONLY] URL to obtain image via HTTP GET request.
   string id;  ///< [READ ONLY] Id of uploaded image.
};

typedef sequence<Image> ImageList;

}; }; }; // end of namespace

/**
 * @}
 */