Light Mode

Responses

Salla have applied all the technical standards have been placed by the REST principles. So, developers can always receive, read, decode, or understand the errors in responses based on the following form:

Color Code	Response	Status	Meaning
$\#14cc27$	200	Success	The request has succeeded.
$\#14cc27$	201	Created	API call has been accepted for processing. The sent resource has been successfully inserted/updated at our database
$\#14cc27$	202	Accepted	API call has been accepted for processing. This status code is used only when the sent resource has been successfully deleted from our database
$\#14cc27$	204	No content	The server successfully processed the request, but is not returning any content

:::info
With a 2xx success response, the response body will include a status field reflecting the HTTP status (2xx) and a success field set to true and , as shown in the following example:

{
  "status": 200,
  "success": true,
  "data": {
    "message": null,
    "code": 200
  }
}

:::

This API uses the following error codes:

With every request you might get these responses in case of any error :

Color Code	Response	Slug	Status	Meaning
$\#fcba03$	400	bad_request	Bad Request	Invalid parameters, fields or filters
$\#fcba03$	401	unauthorized	Unauthorized	authorization error (invalid basic auth data or API key)
$\#fcba03$	403	forbidden	Forbidden	The server understood the request, but is refusing it (blocked due to many errors in particular time) or the access is not allowed.
$\#fcba03$	404	not_found	Not Found	The specified resource/url-path could not be found
$\#fcba03$	405	method_not_allowed	Method Not Allowed	The method used is not allowed.
$\#fcba03$	406	not_acceptable	Not Acceptable	The format used is not acceptable.
$\#fcba03$	410	gone	Gone	The resource requested is no longer available.
$\#fcba03$	422	validation_failed	Unprocessible Entity	used if the server cannot process the enitity, e.g. mandatory fields are missing in the payload.
$\#fcba03$	429	too_many_requests	Too Many Requests	Rate limit exceeded.
$\#f03c15$	500	server_error	Internal Server Error	We might be updating our services, please wait a while before trying again.
$\#f03c15$	503	service_unavailable	Service Unavailable	We were unable to handle the HTTP request due to a temporary overloading or maintenance of the server. Please try again later.

:::caution[Important]
In case of multiple errors resulting in a 4xx response, the response will include a list of "fields" and an array of error messages as "values" for those fields, explaining the errors for each field. Here is an example for reference.

```json { "status": 422, "success": false, "error": { "code": "error", "message": "alert.invalid_fields", "fields": { "first_name": [ "الاسم الاول للعميل مطلوب" ] } } } ``` ```json { "status": 422, "success": false, "error": { "code": "error", "message": "alert.invalid_fields", "fields": { "first_name": [ "الاسم الاول للعميل مطلوب" ], "last_name": [ "الاسم الاخير للعميل مطلوبً" ], "country_code": [ "حقل كود الدولة مطلوب" ], "mobile_code_country": [ "حقل رمز الدولة للجوال مطلوب" ], "mobile": [ "رقم الجوال مطلوب" ] } } } ```

:::

Last modified: 5 months ago