Documentación - Contenedor 'qualification'

Introducción

El contenedor qualification sirve principalmente para ver y agregar calificaciones y comentarios a los objetos de la página.
Disponible

Tipos compatibles

Las calificaciones tienen un tipo que actualmente son los siguientes:
(Identidicador: nombre)
- 1: receta
- 2: tip
- 3: video
- 4: menu (compilacion)
- 5: concurso (en desuso)
- 6: otros
- 7: blog
- 8: quiz

Solicitud básica

POST /v6/qualification
trx=:Trx
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=test Regresa una confirmación que funciona el servicio
- service=list Regresa la lista de calificaciones
- service=insert Crea una nueva lista de colección
- service=update es el tipo de servicio solicitado:
- service=rating es el tipo de servicio solicitado:

Servicio 'list'

Recupera la lista de calificaciones paginadas para un tipo de objeto / clave 
POST /v6/qualification/list
trx=:Trx
service=list
language=:Language
device=:Device
type=:Type
key=:Key
quantity=:Cantidad
page=:Pagina
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 Tipos compatibles
key es la clave de la lista de calificaciones del tipo especificado anteriormente.
quantity es la cantidad por pagina.
page es la pagina. Por ejemplo si quantity=10 y page=3 regresara las calificaciones del número 21 a 31

El sistema regresará los datos del resultado en cualquier caso, de formato general:
{
  "trx": "1",
  "status": "ok",
  "payload": [
    {
      "client": {
        "avatar": "https://cdn.kiwilimon.com/kiwilimon/static/icono-usuario.svg",
        "key": null,
        "lastname": null,
        "name": "Anónimo"
      },
      "comment": " y muy facil de preparar \n\nMe encantó es delicioso ",
      "datestr": "2016-08-12 12:08:40 +0000 +0000",
      "key": 28015,
      "prating": "100",
      "qualification": 5
    },
     ...
  ]
}
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 comentarios solicitados.

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 '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",
  error: "",
  payload: {"collection":"123", "key":"456"}
}
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 de la nueva colección y la clave del objeto en la colección si status = "ok".

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