Formato de Respuesta
Todas las respuestas de la API respetan el formato descripto en esta página.
Encabezado de la respuesta (header)
Los posibles codigos del header de las respuestas son los siguientes:
Contenido de la respuesta (body)
El contenido de las respuestas de la API se recibe en formato JSON, y tiene esta estructura genérica:
No siempre estarán presentes todas las propiedades, depende de que tipo de pedido se haya realizado y el resultado del mismo. Se constituye por los siguientes elementos:
success - Presente en todas las respuestas. Indica true si la llamada ha sido procesada con éxito, false en caso contrario. Es útil para hacer un chequeo general más allá del status code del header y saber si la respuesta contiene las propiedades data o error.
paging - En las respuestas de pedidos GET a las colecciones, la propiedad paging nos indicará los límites del listado con datos útiles como offset (a partir de qué elemento inicia el listado), limit (la cantidad de elementos en el listado actual recibido), result (la cantidad total de elementos coincidentes con la búsqueda) y total (el total de elementos en la colección).
data - En las respuestas de pedidos GET a las colecciones, la propiedad data es un array con los elementos requeridos. En caso de que la colección esté vacía, será un array vacío. En las respuestas de pedidos GET a un elemento, la propiedad dataserá un objeto con todos los campos del elemento en cuestión.
error - Aquí se indica el detalle del error. Cada error tiene un status que coincide con el status de la respuesta HTTP, untype que lo identifica y un userMessage con el mensaje textual que puede mostrarse al usuario.
Los valores de type pueden ser los siguientes:
Last updated