Introducción
Este contenedor permite hace las dos operaciones básicas sobre una colección: agregar una receta, y remover una receta de ella.
Se realiza a través de dos métodos, POST y DELETE.
Agregar receta
Para agregar una receta a una colección:
[POST] /v2/coleccionreceta
token=[token]
coleccion=[clave]
receta=[clave]
formato=json
Los campos son los siguientes:
token: El token del chef conectado e identificado a través del contenedor 'login'.
coleccion: La clave de la colección en donde desea agregar la receta. Solamente se aceptan colecciones de tipo 2 y 3 (favoritos y normales), ya que de tipo 1 y 4 son inmutables (solamente el sistema las puede modificar).
También se puede enviar la palabra 'favoritos' para apuntar directamente la colección de favoritos sin conocer la clave. El token funciona de puente automático para encontrar la colección favorita del chef.
receta: La clave de la receta que desea agregar a la colección.
formato: Es el formato en el cual queremos los resultados. Es uno de 'json', 'xml' o 'txt. Es un parámetro opcional, y si no esta especificado regresa un JSON por defecto.
Resultados posibles:
Error 401: token invalido
Error en el formato solicitado:
{
"estatus" => "Error",
"error":2,
"message":"Error, receta no válida"
}
Si todo esta bien, regresa un estatus OK:
Quitar una receta
Para quitar una receta de una colección:
[DELETE] /v2/coleccionreceta/:Token/:Coleccion/:Receta/:Formato
Los campos son los siguientes:
:Token: El token del chef conectado e identificado a través del contenedor 'login'.
:Coleccion: La clave de la colección de la cual desea quitar la receta. Solamente se aceptan colecciones de tipo 2 y 3 (favoritos y normales), ya que de tipo 1 y 4 son inmutables (solamente el sistema las puede modificar).
:Receta: La clave de la receta que desea quitar de la colección.
:Formato: Es el formato en el cual queremos los resultados. Es uno de 'json', 'xml' o 'txt. Es un parámetro opcional, y si no esta especificado regresa un JSON por defecto.
Resultados posibles:
Error 404: formato invalido, recurso no disponible
Error 401: token invalido
Error en el formato solicitado:
{
"estatus" => "Error",
"error":2,
"message":"Error, colección inmutable"
}
Si todo esta bien, regresa un estatus OK: