Documentación - Contenedor 'familias'

¿Buscas la Documentación API v1?

Introducción

En la estructura de clasificación de recetas de Kiwilimón, hay varias familias. La cantidad puede variar en el tiempo.
Al escribir este manual, las 5 familias básicas son:
  • Recetas
  • Tipo de cocina
  • Tipo de cocción
  • Preferencias
  • Temporadas

  • * Si hay cambios en las cinco familias, o se llegara a agregar una nueva familia, los objetos estarán automáticamente reajustados en el GRAPH en tiempo real.

    El contenedor familias tiene dos recursos disponibles en el sistema.

    Recurso 'data'

    Para conocer las familias disposibles, puede consumir el recurso data de la manera siguiente:
    [GET] /v2/familias/data.json
    El sistema regresará los datos de las familias disponibles por orden de importacia en un arreglo:
    [
      {FAMILIA-1},
      {FAMILIA-2},
      ... 
    ]
    
    El código regresado es un arreglo de familias.
    {FAMILIA-n} representa el objecto básico data de una familia (ver capítulo 'familia').
    Las familias estan ordenadas por el campo 'orden'.

    Recurso 'mdata'

    Para armar una página o una APP con las familias y sus clasificaciones contenidas en ellas de manera compacta en una sola llamada (APP), puede consumir el recurso mdata de la manera siguiente:
    [GET] /v2/familias/mdata.json
    El sistema regresará los datos de las familias disponibles por orden de importacia en un arreglo, así como las clasificaciones de primer nivel de cada una:
    [
      {FAMILIA-1},
      {FAMILIA-2},
      ... 
    ]
    
    El código regresado es un arreglo de familias.
    {FAMILIA-n} representa el objecto básico mhijos de una familia (ver capítulo 'familia').
    Las familias estan ordenadas por el campo 'orden'.

    Ejemplos

    Todas las familias en JSON:
    [GET] /v2/familias/data.json
    Resultado:
    [ {"clave":"rec",
       "orden":1,
       "nombre":"Recetas",
       "estatus":1,
       "link":"recetas",
       "titulo":"Conoce nuestras deliciosas recetas",
       "palabras":"\u00bfEstas buscando recetas de cocina? Kiwilimon tiene las mejores recetas de cocina probadas con calificaciones, comentarios, tips y videos.",
       "ruta":"\/recetas",
       "cantidadclasificaciones":14
      },
      {"clave":"coc",
       "orden":2,
       "nombre":"Tipo de cocina",
       "estatus":1,
       "link":"tipo-de-cocina",
       "titulo":"",
       "palabras":"",
       "ruta":"\/tipo-de-cocina",
       "cantidadclasificaciones":22
      },
      {"clave":"tem",
       "orden":3,
       "nombre":"Temporadas",
       "estatus":1,
       "link":"temporada",
       "titulo":"",
       "palabras":"",
       "ruta":"\/temporada",
       "cantidadclasificaciones":13
      },
      {"clave":"pref",
       "orden":4,
       "nombre":"Preferencia",
       "estatus":1,
       "link":"preferencia",
       "titulo":"",
       "palabras":"",
       "ruta":"\/preferencia",
       "cantidadclasificaciones":14
      }
    ]