Respuestas de la API

weetrust utiliza códigos de respuesta HTTP convencionales para indicar el éxito o el fracaso de una solicitud de API.

Códigos de estado HTTP

Peticiones satisfactorias

Para las peticiones satisfactorias los códigos regresan 2xx que indican éxito.

Estructura de la respuesta

CampoDescripción
responseDataEn esta propiedad se recibe toda la data de la respuesta
messageDescripción de la respuesta de la solicitud
responseCodeCódigo de la petición 2xx
{
  "responseData": [
    {
      "documentID": "string",
      "documentType": "string",
      "status": "string",
    }
  ],
  "message": "Document fetched successfully",
  "responseCode": "200"
}

Peticiones fallidas

Los códigos en el rango 4xx indican un error que falló dada la información proporcionada (por ejemplo, se omitió un parámetro requerido, falló una carga, etc.)

Estructura de la respuesta

CampoDescripción
responseDataEn esta propiedad se recibe toda la data de la respuesta
messageDescripción de la respuesta de la solicitud
successIndica si fue exitosa o no la solicitud.
responseCodeCódigo de la petición 4xx
{
    "responseData": {},
    "message": "Invalid Parameters",
    "success": false,
    "responseCode": 400
}

Código HTTP 5XX

Los códigos en el rango 5xx indican un error con el servicio de weetrust.