Estructura Response
Estructura
La estructura devuelta de cada petición se compone de la siguiente manera cuando se consume un servicio de Impuesto Nacionales (SIN) desde Samp:
{
"status_api": 200,
"description": "Descripcion cualquiera de estado",
"content": {
"mensajesList": "Es un parámetro que se devuelve cuando sucede algo con los parámetros enviados o devueltos desde Impuestos Nacionales",
"contenido de respuesta desde el Servicio de Impuestos Nacionales"
}
}
Ejemplo de respuesta desde el SIN
A continuación se muestra un ejemplo de respuesta SIN desde Sampi:
{
"status_api": 200,
"description": "Descripcion cualquiera de estado",
"content": {
"codigo": "codigo cufd",
"codigoControl": "codigo control",
"direccion": "direccion",
"fechaVigencia": {
"date": "fecha",
"timezone_type": 3,
"timezone": "timezone"
},
"transaccion": "true o false"
}
}
Opciones
| Elemento | Descripción |
|---|---|
| *status_api | Describe el estado devuelto de la respuesta. |
| *description | Descripción de la respuesta devuelta. |
| content | Contenido de la solicitud en caso que se requiera. |
Cuando se consume un servicio de Impuestos Nacionales (SIN) desde Sampi, es importante tener en cuenta los siguientes aspectos:
-
Descripción (Description): La descripción proporcionada en la respuesta es una descripción genérica y no sigue un formato estandarizado de mensajes. Esta descripción puede contener información adicional sobre la respuesta, pero su formato puede variar según el contexto y el servicio específico.
-
Estado de la API (status_api): Los códigos de estado HTTP se utilizan para indicar el estado de la respuesta obtenida del servicio de Impuestos Nacionales. Por ejemplo, un código de estado 200 indica que la solicitud se procesó correctamente (OK), mientras que un código 404 indica que el recurso solicitado no se encontró (Not Found). Estos códigos de estado proporcionan información clara sobre el resultado de la solicitud al cliente.
-
Servicios no relacionados con SIN: Para los servicios que no están relacionados con Impuestos Nacionales, como la autenticación u otros servicios internos, es posible que la estructura de la respuesta sea diferente. En estos casos, la respuesta puede contener información específica relacionada con el servicio en cuestión, como tokens de autenticación o mensajes de confirmación.
Al considerar estos aspectos al consumir servicios de Impuestos Nacionales desde Sampi, los usuarios pueden interpretar adecuadamente las respuestas recibidas y tomar las acciones necesarias en consecuencia.