Documentación - Contenedor 'collection'

Introducción

El contenedor collection sirve principalmente para agregar y quitar objetos en las colecciones del cliente.
Disponible

Objetos compatibles

Las colecciones pueden almacenar los tipos de objetos siguientes:
(Identidicador: nombre)
- r: receta
- cr: clasificación de receta
- fr: familia de receta
- kr: compilación de receta
- t: tip
- ft: familia de tip
- ct: clasificación de tip
- kt: compilación de tip
- a: artículo
- ca: clasificación de artículo
- p: producto a la venta
- q: quiz
- cc: colección de otro cliente

Solicitud básica

POST /v6/collection
language=:Language
device=:Device
service=:Service
[otros parametros segun el servicio]

language explicado en el capítulo Generalidades
device explicado en el capítulo Generalidades
service es el tipo de servicio solicitado:
- service=favorite Agrega un objeto a favoritos
- service=list Regresa la lista de colecciones
- service=newlist Crea una nueva lista de colección
- service=create es el tipo de servicio solicitado:
- service=deletelist es el tipo de servicio solicitado:
- service=modifylist es el tipo de servicio solicitado:
- service=insert es el tipo de servicio solicitado:
- service=deleteobject es el tipo de servicio solicitado:

Servicio 'favorite'

Agrega un objeto a la colección "Favoritos" (colección privada)

POST /v6/collection
trx=1
service=favorite
language=:Language
device=:Device
type=:Type
key=:Key

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
type es el identificador del tipo de objeto explicado en el capítulo Objetos compatibles
key es la clave del objeto a agregar a la lista de favoritos. El objeto debe de existir en la base de datos o un error será regresado.

El sistema regresará los datos del resultado en cualquier caso, de formato general:

{
  trx: "1",
  status: "ok",
  payload: "123",
  message: ,
}

trx es el mismo número de transacción que la solicitud
status es "ok" o "error"
payload contiene la clave del objeto en favoritos si status = "ok".
message contiene el texto de error si status = "error".

Servicio 'list'

Regresa la lista de colecciones del cliente conectado

POST /v6/collection
trx=1
service=list
language=:Language
device=:Device

{
  trx: "1",
  status: "ok",
  payload: [
    { key: 123,
      name: "coleccion 1"},
    { key: 124,
      name: "coleccion 2"}
  ],
  message: ,
}

trx es el mismo número de transacción que la solicitud
status es "ok" o "error"
payload contiene la lista de colecciones del cliente conectado, si status = "ok".
message contiene el texto de error si status = "error".

Servicio 'newlist'

Crea una nueva lista de coleccion de tipo pública, y le agrega un objeto

POST /v6/collection
trx=1
service=newlist
language=:Language
device=:Device
name=:ListName

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 el servicio solicitado 'newlist'
name es la nombre de la nueva lista de colección a crear. Pertenecerá al usuario identificado y será de tipo pública

El sistema regresará los datos del resultado en cualquier caso, de formato general:

{
  trx: "1",
  status: "ok",
  payload: "12345",
  message: ,
}

trx es el mismo número de transacción que la solicitud
status es "ok" o "error"
payload contiene la clave de la nueva lista si status = "ok".
message contiene el texto de error si status = "error".

Servicio 'create'

Crea una nueva coleccion de tipo pública, y le agrega un objeto

POST /v6/collection
trx=1
service=create
language=:Language
device=:Device
name=:CollectionName
type=:Type
key=:Key

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
name es la nombre de la nueva colección a crear. Pertenecerá al usuario identificado y será de tipo pública
type es el identificador del tipo de objeto explicado en el capítulo Objetos compatibles
key es la clave del objeto a agregar a la lista de favoritos. El objeto debe de existir en la base de datos o un error será regresado.

El sistema regresará los datos del resultado en cualquier caso, de formato general:

{
  trx: "1",
  status: "ok",
  payload: {"collection":"123", "key":"456"},
  message: ,
}

trx es el mismo número de transacción que la solicitud
status es "ok" o "error"
payload contiene la clave de la nueva colección y la clave del objeto en la colección si status = "ok".
message contiene el texto de error si status = "error".

Servicio 'deletelist'

Borra la coleccion

POST /v6/collection
trx=1
service=deletelist
language=:Language
device=:Device
key=:Key

{
  trx: "1",
  status: "ok",
  payload: true,
  message: ,
}

trx es el mismo número de transacción que la solicitud
status es "ok" o "error"
payload retorna true si status = "ok".
message contiene el texto de error si status = "error".

Servicio 'modifylist'

Modifica el nombre de una colección

POST /v6/collection
trx=1
service=modifylist
language=:Language
device=:Device
key=:Key
name=:NewName

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
key es la clave de la colección a modificar.
name es el nuevo nombre de la colección.

El sistema regresará los datos del resultado en cualquier caso, de formato general:

{
  trx: "1",
  status: "ok",
  payload: true,
  message: ,
}

trx es el mismo número de transacción que la solicitud
status es "ok" o "error"
payload retorna true si status = "ok".
message contiene el texto de error si status = "error".

Servicio 'insert'

Agrega un objeto a la colección apuntada por su clave (colección publica)

POST /v6/collection
trx=1
service=insert
language=:Language
device=:Device
collection=:CollectionKey
type=:Type
key=:Key

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
collection es la clave de la colección a la cual agregar el objeto. Tiene que existir, pertenecer al usuario identificado y ser de tipo pública
type es el identificador del tipo de objeto explicado en el capítulo Objetos compatibles
key es la clave del objeto a agregar a la lista de favoritos. El objeto debe de existir en la base de datos o un error será regresado.

El sistema regresará los datos del resultado en cualquier caso, de formato general:

{
  trx: "1",
  status: "ok",
  error: "",
  payload: "123",
}

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 clave del objeto en la colección si status = "ok".

Servicio 'deleteobject'

Elimina un objeto de la colección apuntada por su clave (colección publica)

POST /v6/collection
trx=1
service=deleteobject
language=:Language
device=:Device
collection=:CollectionKey
type=:Type
key=:Key

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
collection es la clave de la colección a la cual eliminar el objeto. Tiene que existir, pertenecer al usuario identificado y ser de tipo pública
type es el identificador del tipo de objeto explicado en el capítulo Objetos compatibles
key es la clave del objeto a eliminar de la lista. El objeto debe de existir en la base de datos o un error será regresado.

El sistema regresará los datos del resultado en cualquier caso, de formato general:

{
  trx: "1",
  status: "ok",
  payload: true,
  message: ,
}

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".

Códigos de error

Si el usuario no esta conectado, regresa un estatus 401 not authorized
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