Response Model

A common understanding

All responses from the different endpoint requests will give a standard model. That response is common for all functions except for the data model which is a function-related response. Here, we are going to explain the Response Model that you will get for all requests sent to the API.

Response FieldTypeDescription
IsSuccessstring"true" or "false" indicating the status of your request
MessagestringThe message response associated with the request done
ValidationErrors/FieldsErrorsmodelA model that contains two keys "Name" and "Error". This is used to indicate the validation result for all parameters you have sent in your request. This can have one or more items based on the invalid parameter count
DatamodelThis model is the response data of each endpoint.