Chenile API Model

The Chenile API model defines the messaging constructs within Chenile. Chenile services have flexible signatures that accept a myriad of input parameters and return values. Chenile does not impose any restrictions on a service signature.

Chenile has unified the API signatures for good responses, errors and warnings. Hence the return value for a Chenile service in HTTP and other RPC based protocols has been standardized to a GenericResponse structure that is discussed below

GenericResponse

The return value that is exposed by the HTTP transport is defined by a class called GenericResponse. The GenericResponse class is a wrapper over the response that is returned by the service. It is capable of returning the errors and warnings in addition to the response from the service. Selected fields are discussed below with commentary above them.

 	public class GenericResponse{
 		// denotes if the request is a success or failure
 		private boolean success = false;
		private List<ResponseMessage> errors;
		private Object data;
		// renders as JSON string
		private HTTPStatus code;
		// Below fields are from ResponseMessage and will be the same as errors[0] above
		// renders as JSON string
		private int subErrorCode;
		private String field;
		private String description;
		private ErrorType severity;
		private Object[] params;
		...
 	}

GenericResponse Fields

ResponseMessage fields in GenericResponse

All the responseMessage fields are a replica of errors[0]. So for example, if there are 2 ResponseMessage object returned in the errors array, then the subErrorCode, description, field etc. at the GenericResponse level will be the same as the subErrorCode, description, field etc. from the first element in the errors array.

ResponseMessage

The ResponseMessage is a structure that contains more information about errors and warnings. Selected fields are discussed below:

	public class ResponseMessage {
		// renders as JSON string
		private HTTPStatus code;
		// renders as JSON string
		private int subErrorCode;
		private String field;
		private String description;
		private ErrorType severity;
		private Object[] params;
	}

ResponseMessage fields