Error de la API
Contrato de respuesta: error de la api.
Este esquema conserva los nombres técnicos, tipos y restricciones de la API. Las propiedades incluidas en required son obligatorias; nullable admite null. oneOf requiere una variante, anyOf admite las variantes indicadas y allOf combina sus restricciones.
Propiedades principales
| Propiedad | Tipo | Obligatoria | Restricciones |
|---|---|---|---|
message | string | Sí | Sin restricciones adicionales en este nivel. |
code | string | Sí | Sin restricciones adicionales en este nivel. |
issues | array de object | No | Sin restricciones adicionales en este nivel. |
Ejemplo de la estructura
Este objeto es una muestra sintética de la estructura. Los identificadores, fechas, estados y tokens sirven como ejemplos de formato; no describen una operación real ni valores predeterminados.
{
"message": "valor_de_ejemplo",
"code": "valor_de_ejemplo"
}Ver el esquema JSON completo
{
"type": "object",
"properties": {
"message": {
"type": "string"
},
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
},
"required": [
"message",
"code"
]
}Operaciones que utilizan este esquema
- Listar sobres
- Obtener un sobre
- Obtener varios sobres
- Crear un sobre
- Crear un documento desde una plantilla
- Actualizar un sobre
- Eliminar un sobre
- Cancelar un sobre
- Duplicar un sobre
- Distribuir un sobre
- Redistribuir un sobre
- Consultar la auditoría
- Descargar la auditoría
- Descargar el certificado del sobre
- Añadir archivos al sobre
- Actualizar archivos del sobre
- Eliminar un archivo del sobre
- Descargar un archivo
- Obtener un destinatario
- Añadir destinatarios
- Actualizar destinatarios
- Eliminar un destinatario
- Registrar un rechazo externo
- Obtener un campo
- Añadir campos
- Actualizar campos
- Eliminar un campo
- Listar adjuntos
- Crear un adjunto
- Actualizar un adjunto
- Eliminar un adjunto
- Listar carpetas
- Crear una carpeta
- Actualizar una carpeta
- Eliminar una carpeta
- Crear un token de integración
- Verificar un token de integración