Documentación - Contenedor 'shoppinglist'

Introducción

El contenedor shoppinglist sirve para manejar la lista del súper del client conectado. Permite agregar, modificar, quitar recetas y ingredientes así como imprimir, enviar, ordenar, borrar la lista.
Disponible

Solicitud básica

language explicado en el capítulo Generalidades
device explicado en el capítulo Generalidades
service es el tipo de servicio solicitado:
- service=list Regresa la lista del súper completa
- service=addrecipe Agrega una receta a la lista del súper con todos sus ingredientes o parte de ellos
- service=deleterecipe Quita una receta del la lista del súper con todos sus ingredientes
- service=addingredient agrega un ingrediente extra
- service=deleteingredient borra un ingrediente extra
- service=updateingredient cambia el estatus del ingrediente (comprado/no comprado; descartado/usado)
- service=deletelist borra todo y vacia la lista

Servicio 'list'

Regresa la lista del súper en modo recetas o pasillos
trx es el número de transacción. Opcional. Es regresado al cliente de manera transparente.
language explicado en el capítulo Generalidades
device explicado en el capítulo Generalidades
service fijo, puesto al valor list
mode recipe: regresa la lista por recetas; aisle: regresa la lista por pasillos

El sistema regresará los datos del resultado en cualquier caso, de formato general:
trx es el mismo número de transacción que la solicitud
status es "ok" o "error"
error contiene el texto de error si status = "error".
payload contiene la lista de colecciones del cliente conectado, si status = "ok".

Servicio 'addrecipe'

Agrega una receta a la lista del súper
trx es el número de transacción. Opcional. Es regresado al cliente de manera transparente.
language explicado en el capítulo Generalidades
device explicado en el capítulo Generalidades
service fijo, puesto al valor addrecipe
key clave de la receta a agregar a la lista de súper

El sistema regresará los datos del resultado en cualquier caso, de formato general:
trx es el mismo número de transacción que la solicitud
status es "ok" o "error"
payload contiene la clave generada en lista de súper, si status = "ok".
message contiene el texto de error si status = "error".

Servicio 'deleterecipe'

Elimina una receta de la lista del súper
trx es el número de transacción. Opcional. Es regresado al cliente de manera transparente.
language explicado en el capítulo Generalidades
device explicado en el capítulo Generalidades
service fijo, puesto al valor deleterecipe
key clave de la receta a eliminar a la lista de súper

El sistema regresará los datos del resultado en cualquier caso, de formato general:
trx es el mismo número de transacción que la solicitud
status es "ok" o "error"
payload contiene true, si status = "ok".
message contiene el texto de error si status = "error".

Servicio 'addingredient'

Agrega un ingrediente extra a la lista del súper
trx es el número de transacción. Opcional. Es regresado al cliente de manera transparente.
language explicado en el capítulo Generalidades
device explicado en el capítulo Generalidades
service fijo, puesto al valor addingredient
ingredientname nombre del ingrediente extra a agregar a la lista de súper

El sistema regresará los datos del resultado en cualquier caso, de formato general:
trx es el mismo número de transacción que la solicitud
status es "ok" o "error"
payload contiene true, si status = "ok".

Servicio 'deleteingredient'

Agrega un ingrediente extra a la lista del súper
trx es el número de transacción. Opcional. Es regresado al cliente de manera transparente.
language explicado en el capítulo Generalidades
device explicado en el capítulo Generalidades
service fijo, puesto al valor deleteingredient
extrakey clave del ingrediente extra a eliminar de la lista de súper

El sistema regresará los datos del resultado en cualquier caso, de formato general:
trx es el mismo número de transacción que la solicitud
status es "ok" o "error"
payload contiene true, si status = "ok".

Servicio 'updateingredient'

Cambia el estatus de un ingrediente extra a la lista del súper:
(comprado/no comprado; descartado/usado)
trx es el número de transacción. Opcional. Es regresado al cliente de manera transparente.
language explicado en el capítulo Generalidades
device explicado en el capítulo Generalidades
service fijo, puesto al valor updateingredient
ingredient clave del ingrediente extra a modificar
status estatus que tomara el ingrediente [0,1,2]

El sistema regresará los datos del resultado en cualquier caso, de formato general:
trx es el mismo número de transacción que la solicitud
status es "ok" o "error"
payload contiene true, si status = "ok".
message contiene el mensaje de error si status="error".

Servicio 'deletelist'

Borra todo y vacía la lista del súper
trx es el número de transacción. Opcional. Es regresado al cliente de manera transparente.
language explicado en el capítulo Generalidades
device explicado en el capítulo Generalidades
service fijo, puesto al valor deletelist

El sistema regresará los datos del resultado en cualquier caso, de formato general:
trx es el mismo número de transacción que la solicitud
status es "ok" o "error"
payload contiene true, si status = "ok".
message contiene el mensaje de error si status="error".

Códigos de error

Si el sistema esta en mantenimiento, puede regresar un estatus 503
Si accede otros métodos, puede regresar un estatus 501
Si hay un problema en el sistema, puede regresar un estatus 500