Estructura de la respuesta de la API general
ver | versión exacta de la API que ha generado la respuesta. |
time | datetime de respuesta. |
action | acción a realizar con los datos (update = actualización de modificaciones, refresh = refrescar todos los datos, testing = indica que se está recibiendo una respuesta de test de autentificación). |
error | variable que contendrá, si se produce, el código de error generado. Los errores están detallados en el apartado Códigos de error de la API. |
schema | configuración específica para el cliente. |
data_schema | indica el nombre de los campos de las sub-matrices de data. |
data_schema_info | guarda información descriptiva de las tablas y de cada campo. |
data | matriz de datos separados por tablas. |
image_packs | URLs a los paquetes de imágenes (generados a partir de las secciones principales) de descarga para modo-offline. |
offline_files | listado de archivos relacionados con los ítems exportados. Solo en modo “action”=”refresh” y si el conector posee en esquema el Modo offline activo. |
page_count | número de página. (Si no hay paginación no se mostrará). |
page_length | cantidad de ítems por página. (Si no hay paginación no se mostrará). |
next_page | URL de la llamada a la siguiente página. Si se ha llegado a la última página este campo estará vacío. (Si no hay paginación no se mostrará). |
Los datos de las sub-matrices contenidos en “data” tendrán un primer parámetro de estado para indicar si un registro es nuevo, actualizado o eliminado. Su formato será: STATUS = M/D (M=modify, D=delete). Ejemplo:
“data_schema”: [
“{nombre tabla}”: [ 0: “STATUS”, 1: “ID”, 2: “name”, … ],
...
] ,
“data_schema_info”: [
“{nombre tabla}“: [
“{nombre de campo}”: {
“type”: “{string|numeric|list|boolean|datetime|image|file}”,
“origin”:”{database|formula|template|channel}”,
“language_code”: “{en|es|fr|...}”,
“basename”: “'{nombre del campo sin sufijo de idioma}”,
“sanitized”: “{nombre del campo preparado para usar en bases de datos}”,
“sizes”: [
“{extension}”: {“'width”: {tamaño horiz.}, “height”: {tamaño vert.} },
...
]
}, ...
], ...
] ,
“data”: [
“{nombre tabla}”: [
[ “M”, 123, “sección 1”, … ]
Todos los campos de las tablas contenidas en data tienen el mismo formato de asignación excepto los campos de tipo imagen y archivo que tienen una estructura de matriz con los siguientes parámetros:
{n} = [ ← campo 'n' relacionado con una imagen o archivo
Elemento de galería 1:
[
STATUS (M = modified , U=unmodified),
ID (identificador único de archivo formato md5),
URL de archivo (si es imagen pertenece a uno de los recortes),
URL de archivo (si es imagen pertenece a otro de los recortes),
…
],
Elemento de galería 2:
[ … ],
...
]
], ...
] ,