Rectificaciones. API RSS

28.06.2017

La API de Rectificaciones da acceso a la información del registro de rectificaciones del sitio web del Idescat.

La utilización de este servicio comporta la aceptación de las condiciones de uso de las API del Idescat.

Resumen
URI base https://api.idescat.cat/rectificacions/v1/{operación}.{formato}[?parámetros]
Método HTTP GET
Formatos de la respuesta xml, json, php
Versión 1.00 (20.10.2010)
Atajos Petición, Respuesta
Operaciones cerca, categories
Widgets que utilizan este servicio

1. Petición

1.1. Características básicas

Toda petición debe especificar obligatoriamente el servicio, la versión, la operación y el formato. Versión y operación son características específicas de cada servicio. El servicio de Rectificaciones soporta los formatos de respuesta generales de las API del Idescat. Para más información, consulte el apartado Anatomía de las peticiones en la documentación general de las API del Idescat.

1.1.1. Identificador del servicio y versión

El identificador de este servicio es rectificacions.

https://api.idescat.cat/rectificacions/v1/{…}

1.1.2. Operaciones

Este servicio admite dos tipos de operaciones:

  • cerca: Devuelve las rectificaciones que cumplen el criterio de selección.
    https://api.idescat.cat/rectificacions/v1/cerca.{…}
  • categories: Permite obtener información sobre las categorías utilizadas en la categorización de las rectificaciones.
    https://api.idescat.cat/rectificacions/v1/categories.{…}

1.2. Parámetros específicos

Los parámetros específicos permiten escoger la información que devolverá una determinada operación del servicio. Se pueden especificar como parámetros individuales o en un único parámetro p (forma compacta).

Para conocer los parámetros generales disponibles para cualquier servicio, consulte la documentación de las API del Idescat.

1.2.1. Operación cerca

La operación cerca se puede invocar sin utilizar ningún parámetro específico (resultados no filtrados). En este caso, devolverá las rectificaciones más antiguas.

Ej. 1: Lista de rectificaciones más antiguas en formato JSON y codificación ISO-8859-1
https://api.idescat.cat/rectificacions/v1/cerca.json?enc=iso-8859-1

Para acceder a rectificaciones más recientes debe utilizarse el parámetro desc (o el parámetro posicio).

1.2.1.1. posicio

Como algunas búsquedas pueden devolver un número muy elevado de resultados, la respuesta no siempre los incluirá todos. El parámetro posicio permite especificar cuál deber ser el primer resultado incluido en la respuesta. Por defecto, posicio es igual a cero.

Ej. 2: Lista a partir de la rectificación 21
https://api.idescat.cat/rectificacions/v1/cerca.xml?posicio=20

Los elementos de la respueta opensearch:totalResults y opensearch:itemsPerPage permiten determinar si se están mostrando todos los resultados o no.

1.2.1.2. id

Cuando no va acompañado del parámetro scheme (ver el apartado siguiente), el parámetro id permite seleccionar la información de una rectificación individual.

Ej. 3: Información de la rectificación con el identificador 27
https://api.idescat.cat/rectificacions/v1/cerca.xml?id=27
1.2.1.3. scheme

Este parámetro, acompañado del parámetro id, permite filtrar los resultados por alguna de las categorías utilizadas en la categorización de las rectificaciones. Para conocer los criterios de categorización, utilice la operación categories.

El parámetro scheme se utiliza para seleccionar el criterio y el parámetro id se utiliza para seleccionar la categoría.

Ej. 4: Lista de rectificaciones de la categoría "treball" de la clasificación según "tema"
https://api.idescat.cat/rectificacions/v1/cerca.xml?scheme=tema&id=treball&lang=es

Para incluir más de una categoría, se utilizará la coma.

Ej. 5: Lista de rectificaciones con la categoría "treball" o con la categoría "turisme" de la clasificación según "tema"
https://api.idescat.cat/rectificacions/v1/cerca.xml?scheme=tema&id=treball,turisme&lang=es
			

Para filtrar simultáneamente según dos criterios se utilizará "+" en el parámetro scheme e id:

Ej. 6: Lista de rectificaciones con "servei" igual a "aec" y con "tema" igual a "treball" o a "turisme"
https://api.idescat.cat/rectificacions/v1/cerca.xml?scheme=tema+servei&id=treball,turisme+aec&lang=es
1.2.1.4. published y updated

Estos parámetros filtran los resultados según un periodo temporal: según la fecha en la que se publicó la información antes de ser rectificada (published) y según la fecha en la que se produjo la rectificación (updated). Hay que especificar al menos un día, mes y año en formato AAAAMMDD.

Ej. 7: Lista de rectificaciones desde el 1 de enero del 2010 hasta la actualidad
https://api.idescat.cat/rectificacions/v1/cerca.xml?updated=20100101&lang=es

Para definir un intervalo, se utilizará un guión.

Ej. 8: Lista de rectificaciones desde el 1 hasta el 31 de enero del 2010 (ambos incluidos)
https://api.idescat.cat/rectificacions/v1/cerca.xml?updated=20100101-20100131&lang=es

El guión se puede utilizar para seleccionar las rectificaciones de un determinado día.

Ej. 9: Lista de rectificaciones del día 8 de octubre del 2010
https://api.idescat.cat/rectificacions/v1/cerca.xml?updated=20101008-20101008&lang=es
1.2.1.5. orderby y desc

Por defecto, los resultados se muestran en orden ascendente de fecha de la rectificación (updated). Los parámetros orderby y desc permiten modificar este criterio de ordenación.

  • orderby
    • updated: Ordenado según la fecha de la rectificación. Es el valor por defecto.
    • published: Ordenado según la fecha de publicación de la información antes de ser rectificada.
    • title: Ordenado según la denominación de la información afectada por la rectificación. Esta ordenación depende del idioma.
    • tema: Ordenado según el texto descriptivo del tema de la rectificación. Esta ordenación depende del idioma.
  • desc
    • 0: Orden ascendente. Es el valor por defecto.
    • 1: Orden descendente.

1.2.2. Operación categories

La operación categories se puede invocar sin utilizar ningún parámetro específico para obtener los identificadores de los criterios de categorización de la información.

Ej. 10: Lista de criterios de categorización de las rectificaciones en formato PHP serializado
https://api.idescat.cat/rectificacions/v1/categories.php?lang=es

Los identificadores devueltos se pueden utilizar como parámetro id (ver el siguiente apartado) para obtener sus categorías.

1.2.2.1. id

Para obtener las categorías utilizadas en un determinado criterio, se utilizará el parámetro id.

Ej. 11: Lista de categorías del criterio "tema" en formato XML
https://api.idescat.cat/rectificacions/v1/categories.xml?id=tema&lang=es

1.3. Invocación sin operación

Como en el caso de otras API, esta también admite peticiones con una sintaxis que no requiere especificar operaciones (categories y cerca, en este caso; véase, en la documentación general de las API del Idescat, el apartado 1.4. Invocación sin operación). No obstante, las ventajas de este tipo de invocaciones son menos claras que en otras API porque no supone una simplificación significativa de las peticiones, ya que obliga a definir igualmente dos clases de recursos (categories y rectificacions).

  • Lista de criterios de categorización de las rectificaciones en formato XML
    https://api.idescat.cat/rectificacions/v1/categories.xml?lang=es
  • Lista de categorías del criterio "tema" en formato JSON
    https://api.idescat.cat/rectificacions/v1/categories/tema.json?lang=es
  • Lista de rectificaciones del día 8 de octubre del 2010 en formato PHP serializado
    https://api.idescat.cat/rectificacions/v1/rectificacions.php?updated=20101008-20101008&lang=es
  • Lista de rectificaciones de la categoría "treball" de la clasificación según "tema" en formato XML
    https://api.idescat.cat/rectificacions/v1/rectificacions.xml?scheme=tema&id=treball&lang=es
  • Información de la rectificación con el identificador 27 en formato XML
    https://api.idescat.cat/rectificacions/v1/rectificacions/27.xml?lang=es

2. Respuesta

Para conocer los códigos de respuesta HTTP devueltos y los formatos soportados por cualquier servicio, consulte el apartado 2 de las API del Idescat.

La API de Rectificaciones utiliza, para describir la información, el estándar Atom, ya se trate de listas de rectificaciones (operación cerca) como de criterios de categorización o categorías (operación categories).

2.1. Operación cerca

La operación cerca utiliza, para describir las rectificaciones, el estándar Atom enriquecido con elementos del estándar OpenSearch. Consulte la documentación de estos estándares para conocer la estructura de la respuesta de la operación cerca: aquí sólo se documentan algunos elementos hijos del elemento entry que tienen un uso especial.

2.1.1. title

La operación cerca utiliza el elemento title para especificar la información afectada por la rectificación.

Ej. 12: Elemento title
<entry>
   <title xml:lang="es">Paro registrado</title>
   ...
</entry>

2.1.2. published y updated

La operación cerca utiliza el elemento published para especificar la fecha en la que se publicó la información antes de ser rectificada y el elemento updated para la fecha en la que se produjo la rectificación.

Ej. 13: Elementos published y updated
<published>2009-01-10</published>
<updated>2010-02-15</updated>

2.1.3. content

La operación cerca incluye la descripción de la rectificación en el elemento content en formato XHTML.

Ej. 14: Elemento content
<content xml:lang="es" type="xhtml">
   <div xmlns="http://www.w3.org/1999/xhtml">
      ...
   </div>
</content>

2.1.4. link

Los enlaces a las páginas afectadas por la rectificación se incluyen en elementos link con atributo rel igual a via. El atributo title se utiliza para ofrecer una descripción de la página afectada en el idioma solicitado.

Ej. 15: Elementos link con rel igual a via
<link
   rel="via"
   xml:lang="es"
   type="text/html" 
   href="https://www.idescat.cat/pub/?id=lma&amp;n=8.3.1.1&amp;lang=es" 
   title="Personas de 16 años y más que están a favor de tomar medidas para la protección del medio ambiente.
            Por ámbitos territoriales y tipo de medida"
/>
<link
   rel="via" 
   xml:lang="es"
   type="text/html" 
   href="https://www.idescat.cat/pub/?id=lma&amp;n=8.3.1.2&amp;lang=es" 
   title="Personas de 16 años y más que están a favor de tomar medidas para la protección del medio ambiente.
            Por dimensión del municipio y tipo de medida"
/>

2.1.5. category

La operación cerca clasifica los diferentes resultados utilizando elementos category. El atributo scheme indica el criterio de categorización con la petición a la API que devuelve su lista de categorías posibles (ver el apartado 2.2.). El atributo term indica el identificador de la categoría. El atributo label incluye un literal descriptivo de la categoría en el idioma de la petición.

Ej. 16: Elementos category
<category 
   scheme="https://api.idescat.cat/rectificacions/v1/categories.xml?id=tema&amp;lang=es"
   term="treball"
   label="Trabajo"
   xml:lang="es"
/>
<category
   scheme="https://api.idescat.cat/rectificacions/v1/categories.xml?id=servei&amp;lang=es"
   term="aec"
   label="Anuario estadístico de Cataluña "
   xml:lang="es"
/>
<category 
   scheme="https://api.idescat.cat/rectificacions/v1/categories.xml?id=servei&amp;lang=es"
   term="epa"
   label="Encuesta de población activa"
   xml:lang="es"
/>

2.2. Operación categories

La operación categories utiliza, para exponer la categorización de las rectificaciones, el estándar Atom. Consulte la documentación de este estándar para conocer la estructura de la respuesta de la operación categories: aquí sólo se documentan algunos elementos hijos del elemento entry que tienen un uso especial.

2.2.1. title

Cuando la operación categories se invoca sin parámetro id (lista de criterios de categorización), el elemento title de cada entry incluye el identificador del criterio de categorización.

Ej. 17: Elemento title en una invocación sin id
<entry>
  <id>tag:idescat.cat,2010:rectificacions/categories/tema</id>
  <title>tema</title>
  <content xml:lang="es">Temas</content>
  <category term="1" />
  <link 
    rel="alternate"
    href="https://api.idescat.cat/rectificacions/v1/categories.xml?id=tema&amp;lang=es"
    type="application/atom+xml"
  />
  <updated>2010-10-15</updated>
</entry>

Cuando la operación categories se invoca con parámetro id (lista de categorías del criterio seleccionado), el elemento title de cada entry incluye el identificador de la categoría.

Ej. 18: Elemento title en una invocación con id igual a "tema"
<entry>
  <id>tag:idescat.cat,2010:rectificacions/categories/tema/macromagnituds</id>
  <title>macromagnituds</title>
  <content xml:lang="es">Macromagnitudes</content>
  <updated>2010-10-15</updated>
</entry>

2.2.2. link

Cuando la operación categories se invoca sin parámetro id (lista de criterios de categorización), el elemento link de cada entry incluye en su atributo href la petición a la API de la lista de categorías del criterio especificado en el elemento title de la entry.

Ej. 19: Elemento link en una invocación sin id
<entry>
  <id>tag:idescat.cat,2010:rectificacions/categories/tema</id>
  <title>tema</title>
  <content xml:lang="es">Temas</content>
  <category term="1" />
  <link 
    rel="alternate"
    href="https://api.idescat.cat/rectificacions/v1/categories.xml?id=tema&amp;lang=es"
    type="application/atom+xml"
  />
  <updated>2010-10-15</updated>
</entry>

Cuando la operación categories se invoca con parámetro id (lista de categorías del criterio seleccionado), el elemento link no aparece.

2.2.3. content

Cuando la operación categories se invoca sin parámetro id (lista de criterios de categorización), el elemento content incluye el literal asociado al identificador del criterio de categorización que aparece en el elemento title.

Ej. 20: Elemento content en una invocación sin id
<entry>
  <id>tag:idescat.cat,2010:rectificacions/categories/tema</id>
  <title>tema</title>
  <content xml:lang="es">Temas</content >
  <category term="1" />
  <link
    rel="alternate"
    href="https://api.idescat.cat/rectificacions/v1/categories.xml?id=tema&amp;lang=es"
    type="application/atom+xml"
  />
  <updated>2010-10-15</updated>
</entry>

Este mismo literal aparece dentro del elemento title hijo de feed cuando la operación categories se invoca con id.

Ej. 21: Elemento title hijo de feed en una invocación con id igual a "tema"
<feed xmlns="http://www.w3.org/2005/Atom">
  <id>tag:idescat.cat,2010:rectificacions/categories/tema</id>
  <title xml:lang="es">Temas</title>
  <category term="1" />
  ...
</feed>

Cuando la operación categories se invoca con parámetro id (lista de categorías del criterio seleccionado), el elemento content incluye el literal asociado al identificador de la categoría que aparece en el elemento title.

Ej. 22: Elemento content en una invocación con id igual a "tema"
<entry>
  <id>tag:idescat.cat,2010:rectificacions/categories/tema/macromagnituds</id>
  <title>macromagnituds</title>
  <content xml:lang="es">Macromagnitudes</content>
  <updated>2010-10-15</updated>
</entry>

2.2.4. category

La operación categories utiliza el atributo term del elemento category para expresar si debe aparecer una categoría, y sólo una, del criterio en cuestión para cada rectificación ("1"), si debe aparecer como mínimo una pero pueden aparecer más ("+"), si puede aparecer más de una pero también ninguna ("*") o si la categoría debe ser única pero puede no haber ninguna ("?").

Cuando la operación categories se invoca sin parámetro id (lista de criterios de categorización), el elemento category se asocia a cada elemento entry.

Ej. 23: Elemento category en una invocación sin id
<entry>
  <id>tag:idescat.cat,2010:rectificacions/categories/tema</id>
  <title>tema</title>
  <content xml:lang="es">Temas</content >
  <category term="1" />
  <link
    rel="alternate"
    href="https://api.idescat.cat/rectificacions/v1/categories.xml?id=tema&amp;lang=es"
    type="application/atom+xml"
  />
  <updated>2010-10-15</updated>
</entry>

Cuando la operación categories se invoca con parámetro id (lista de categorías del criterio seleccionado), el elemento category se asocia al elemento feed.

Ej. 24: Elemento category hijo de feed en una invocación con id igual a "tema"
<feed xmlns="http://www.w3.org/2005/Atom">
  <id>tag:idescat.cat,2010:rectificacions/categories/tema</id>
  <title xml:lang="es">Temas</title>
  <category term="1" />
  ...
</feed>

2.3. Errores

Las API del Idescat utilizan códigos de respuesta normalizados para indicar que la petición ha tenido éxito o ha fracasado.

Usted está aquí: