Saltearse al contenido

Validaciones en el API

Para conocer las validaciones específicas de entradas a las endpoints, por favor referirse a las clases de entrada de cada endpoint.

En general, el API responderá con un 400 Bad Request cuando se detecte una validación.

Ejemplo del retorno de un mensaje de validación:

{
"statusCode": 400,
"message": "One or more errors occurred!",
"errors": {
"sendDocumentRequest.IdExterno": [
"El id externo es requerido."
],
"sendDocumentRequest.CodigoActividadEmisor": [
"La actividad comercial del emisor debe ser un código de 6 dígitos."
],
"sendDocumentRequest.ReceptorRequest.IdentificacionReceptorRequest.Numero.Fisica": [
"La 'Cédula física' debe de contener 9 dígitos, sin cero al inicio y sin guiones."
]
}
}

Este sería un ejemplo de la estructura de respuesta:

public class ValidationErrorResponse
{
public int StatusCode { get; set; }
public string Message { get; set; } = default!;
// Dictionary con clave = nombre del campo, valor = lista de errores
public Dictionary<string, List<string>> Errors { get; set; } = new();
}