Response Codes

Introduction

Listed below are all response codes that can be returned by the engine. The codes can both be observed through communication within the engine as well as through responses from the REST API. Listed below are the categories these codes are grouped into:

Code Range	Title
000	Blank
200 - 209	General Success Codes
220 - 229	External Stream Success Codes
400 - 409	Routing Connection Issue Codes
410 - 419	Routing Processing Issue Codes
420 - 439	External Stream Processing Issue Codes
440 - 459	Local Stream Processing Issue Codes
460 - 469	Output Consumer Issues Codes
470 - 479	Output Producer Issues Codes
500 - 599	General Issues Codes

Response Code List

Listed below are all response codes that can be returned by the engine internals or external calls.

Code	Title	Description	Solution
000	Blank	Return used for test cases and default applications.	This response should never be generated, if returned please contact developer.
200	Response OK	Request was performed successfully.	No action required.
220	Stream with given hash exists	A stream using the given credentials already exists, using the previously generated stream.	No action required.
400	Router not connected	Internal error with Router communication.	The Routers are on separate managers and cannot communicate packets between one another. Check implementation for validity.
404	Destination not found	Router could not find another Router with the given tag to send the Packet to.	Validate Router connections. Check implementation for validity.
405	Subtag not found at destination	No subtag action was found at the Tag given.	Validate Router with given Tag to make sure function with subtag is implemented properly.
406	Delimiter used in API request	An illicit API request is made using a delimiter for transferring the data to the engine.	Remove the delimiter from the API request.
407	Malformed packet	The Packet data parameter is malformed.	Make sure each data point passed to the packet contains a key and a value passed as: "key", "value".
410	Router process failure	The Router could not process the given method.	Make sure the method contained in the Router is formatted properly.
420	Source does not exist	Requested data source does not exist.	The data source requested does not exist, validate the request and the implementation.
421	StreamKey does not exist	A Stream with the given key does not exist.	Make sure the stream is properly initialized prior to requesting.
422	Data source unable to authorize	The data source could not be authorized with the given credentials.	Make sure the authorization implementation is valid or the given authorization details are valid.
423	Stream is not ready to be executed	The stream cannot be used because it is not ready to be executed.	Check the implementation and the authorization parameters for validity.
424	Stream is already active	An active stream cannot be re-executed.	No action required.
425	Stream is not active	A non-active stream cannot be killed.	No action required.
426	Subscription type not found	Source does not contain subscription type.	Check the implementation and the request for validity.
427	Irregular subscription response	The data source returned irregular message when attempting to subscribe to the service.	Check the service's status and the subscription implementation.
428	Request type does not exist	The data source does not have the given request type available.	Check the implementation and the request for validity.
429	Irregular request response	The data source returned an irregular message when attempting to request data from external service.	Check implementation and external service for validity.
430	Invalid stream hash	Stream key could not be generated from given properties.	Check the implementation of the stream key generation.
440	Source does not exist	Requested data source does not exist.	Check the implementation and the request for validity.
441	Data source is not ready	Data source is not ready to handle queries.	Validate the source is ready to be used.
442	Data source unable to be added	Data source could not be added.	Check the implementation and all external resources the local stream uses for validity.
443	Data source already exists	Data source given given hash already exists.	No action required.
444	Failed to authorize data source	Data source could not be successfully authorized.	Check the implementation and authorization parameters for validity.
445	Invalid query	The query made to the local source could not be validated.	Make sure the query passed is in the proper format.
446	Data source does not contain queried data	The query passed does not return any stored data.	Check implementation for validity.
447	Query had unexpected failure	Query could not be properly handled by local stream.	Check the implementation using the query for validity.
448	Invalid state query or data instance	Local database determined query to be invalid or data to be invalid.	No action required.
449	Failed to push data to local stream	Local database could not push data to given location.	Check implementation and local database status for validity.
460	Consumer failed to listen	Output consumer failed to successfully listen to consumption channel.	Check the implementation, REST API implementation, and the server port security for port 61100 all for validity.
470	Producer failed to accept new socket	Producer failed to accept and maintain new socket from external connection.	Check the implementation and the external program implementation for validity.
471	Producer key does not exist	Destination key of socket to push external data to does not exist in system.	Validate the external socket connection and the passed key.
472	Producer failed to send data	Producer failed to push data to external source.	Check implementation and external socket connection.
500	Empty required parameter	Call is missing required parameter.	Include required parameter in request.
501	Fatal error occurred	Fatal error in engine has occurred such as corrupted memory.	Locate source in implementation to debug. This code should never be seen.
502	Internal language failure	Internal language failed to recognize command. Caused by protocol being misinterpreted.	Check implementation for validity.
503	Invalid date format	Passed date object is not in the proper format specified by the engine.	Write date parameter with valid formatting.