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 Field

Type

Description

IsSuccess

string

"true" or "false" indicating the status of your request

Message

string

The message response associated with the request done

ValidationErrors/FieldsErrors

model

A 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 item based on the invalid parameters count

Data

model

This model is the response data of each endpoint.


Did this page help you?