Error codes when executing commands to WhiteServer

General error format

{
  "error": {
    "wsError": {
      "code": "string",
      "extCode": "string",
      "desc": "string"
    },
    "agentError": {
      "code": 0,
      "desc": "string"
    },
    "rkError": {
      "code": 0,
      "desc": "string"
    },
    "shError": {
      "code": 0,
      "desc": "string"
    }
  }
}

Description of parameters

Parameter	Parameter type	Description
- wsError	string enum	Whiteserver Error
– code	string	Error code
– extCode	string	Extended error code
– desc	string	Error description
- agentError	string enum	Agent Error
– code	int	Error code
– desc	string	Error description
- rkError	string enum	Rkeeper error
– code	int	Error code
– desc	string	Error description
- shError	string enum	Store House Error
– code	int	Error code
– desc	string	Error description

Error codes

code	extCode	desc/description
BadRequest		There was an error in setting up the request, a detailed description of the error may be returned.
InternalError		Internal Server Error
Timeout		Failed to complete a request to the agent within the allotted time, 2 minutes by default. Possible reasons: no connection between the agent and the server, the agent is not running, not configured, the request took a long time to process.
AuthFailed		Authorization error, invalid token.
License	WsAgent	WsAgent (agentID: {agentId}) - WsAgent license not found
License	WsAggregator	WsAggregator (aggregatorID: {aggregatorId}) - WsAggregator license not found
License	WsProduct	WsProduct(abstract soft) (agentID: {agentId}) - WsProduct license not found (Name is specific to aggregators)
WsaDuplicateOrder		An order with the same external ID has already been received by the agent for creation
WsaOrderCanceledOnKass		Order creation rejected at cash register
WsaOrderCreationCancellation		Error canceling the order being created (the order creation needed to be canceled, but an error occurred)
WsaOrderCreationCancelled		Order creation was terminated due to an internal error
WsaNoOneGuidSpecifiedForOrderSearching		Neither the R-Keeper order ID nor the task ID for creating the order are specified for the order search.
WsaOrderCanceledOnKass		The task of creating an order was cancelled at the cash register
WsaFillingOrderError		Error when filling the created empty order in R-Keeper (for example, the printer is not available..)
WsaOrderError		General error when working with R-Keeper orders
WsaOrderCreationComboComponentNotFound		The combo dish component from the order was not found in the menu
WsaOrderCreationDishNotFound		The dish from the order was not found on the menu
WsaOrderCreationSelectorNotFound		No menu selector found with the specified dish
WsaOrderIgnoredOnPos		The cashier did not have time to respond to the order (and automatic order creation is disabled in the Agent configuration)
WsaOrderingPreferencesError		Incorrect configuration of the order handling mechanism
WsaOrderingSettingNotSpecified		A configuration parameter required to process the order is not specified.
WsaOrderMenuIsUnknownError		The menu was not requested before creating the order (may occur shortly after the initial installation of the Agent)
WsaOrderValidationError		Order validation error in R-Keeper
WsaPriceNotSpecifiedForOnlineOrder		For the online order being created, the price (price.total) is not specified
WsaRk7QueryParseError		Error parsing XML query to R-Keeper (while processing the ExecuteRk7Query task)
WsaPluginException		An exception occurred while processing a task by the plugin.
WsError		Error sent by WhiteServer
WsaConnectionSettingsUpdatingError		Failed to update WhiteServer connection settings
WsaCommandHandling		Error processing command
WsaCommandNotSupported		The agent does not support the command
WsaHandshakeError		Crash when reporting to WhiteServer about Agent enablement
WsaHttpRequest		Error sending HTTP request
WsaHttpStatus		The HTTP response status is different from 200 OK.
WsaInvalidSettings		Incorrect settings (e.g. logging settings)
WsaInvalidWsConnectionSettings		Incorrect connection settings to WhiteServer
WsaParseError		Error parsing Json response from WhiteServer
WsaSendRequest		Error sending request to WhiteServer
WsaLogNotFoundError		The requested log file was not found
WsaUpdatingError		Error installing service pack
WsaSqlError		Error processing task to execute query to SQL server (R-Keeper reporting server)
WsaSh5Error		General task processing error for StoreHouse
WsaSh5ProcedureNotAlowed		Calling the specified procedure is prohibited.
WsaSh5ProcedureNotSpecified		The procedure name was not specified in the request to StoreHouse
The name of the .net exception (e.g. InvalidOperationException)		If for some reason an exception during task processing is not wrapped in the above exceptions, then an error of the following type will be returned to WhiteServer: { "code": "SomeDotNetException", "desc": "Error description" } For example, this is how exceptions thrown from plugins will be handled. If the exception type has a public property named "Code", then its string value will be placed in the "code" field of the Agent response.

Examples of errors

Example: BadRequest - request parameter does not match the model

{
  "error": {
    "wsError": {
      "code": "BadRequest",
      "desc": "Invalid request structure"
    }
  }
}

Example: AuthFailed - attempt to send command without authorization / with invalid token

{
  "error": {
    "wsError": {
      "code": "AuthFailed"
    }
  }
}

Example: Timeout - agent unavailable

{
  "responseCommon": {
    "taskGuid": "49a50e51-46f0-41d7-825e-ac10e1c33faa",
    "taskType": "GetOrder",
    "objectId": 199990106
  },
  "error": {
    "wsError": {
      "code": "Timeout"
    }
  }
}

Example: License - no license for agent

{
  "responseCommon": {
    "taskGuid": "fe5bc9ff-61cf-4f8f-8ae6-cf6d27627fb1",
    "taskType": "GetStopList",
    "objectId": 199995855
  },
  "error": {
    "wsError": {
      "code": "License",
      "desc": "WsAgent"
    }
  }
}