Formato de respuesta de un request exitoso


Cuando un request se procesa de forma exitosa, la respuesta tendrá un formato similar al siguiente:

              
              {
                  "msg": "REQUEST_OK", 
                  "response": {
                    "message_detail": "Datos obtenidos correctamente", 
                    "results": {
                      "estimated_value": 330818.52607497701, 
                      "max_value": 363900.3786824747, 
                      "min_value": 297736.6734674793
                    }
                  }, 
                  "status": "OK"
                }
            
          

Detalle de los campos enviados en el response

El response cumple con un formato estandarizado, siendo el mismo para cualquier endpoint del API.

msg

Mensaje corto indicando el status del request.

response

Campo que contiene los resultados del request y un mensaje detallado.

message_detail

Mensaje detallado del estado del request.

results

Resultados del request realizado.

status

Este es un campo con dos valores posibles: "OK" y "ERROR".