Dirección Base URL

Para recuperar los documentos disponibles de las reuniones, deberá utilizar las siguientes URI:

Base URL
http://www.mercosurambiental.net/ws

Patrones URI

/reuniondocs
/reuniondocs/{evento}
/reuniondocs.json
/reuniondocs.xml

Salida

La salida puede ser especificada concatenando .json o .xml al final del URI del recurso y antes de los diferentes tipos de parámetros para consultar. Si no se especifica, por defecto la salida es json.

Parámetros Adicionales

Los diferentes tipos de datos admitidos en las consultas se describen en la siguiente tabla:

Parametro Tipo Descripción
Entero El tipo esperado es un entero y admite valores >0. Al especificarse un único valor devolverá los registros que coincidan con el valor ingresado. En caso de ingresar 2 valores separados por el carácter | devolverá los datos comprendidos entre ambos.

EJ:
?id=1
?id=1|100
Cadena Cadena de texto alfanumérica con acentos y eñes, cuya longitud máxima por palabra es de 20 caracteres. Considera n términos separados por | y la misma es excluyente.

EJ:
?titulo=mercosur
?titulo=proyecto|Ambiental|gestión
Fecha Se trata de una máscara de fecha representada por una cadena "AAAA-MM-DD" o “AAAA” donde AAAA es un año de 4 dígitos, MM es el mes en 2 dígitos y DD es el día en 2 dígitos. Si se ingresa una única fecha la consulta devolverá los registros cuyo campo coincidan con dicha fecha. En caso de ingresar 2 fechas separadas por | se devolverán los campos cuya fecha se encuentre comprendida entre ambos.

EJ:
?fecha=2013-04-01
?fecha=2013-04-01 | 2013-08-30
?fecha=2009|2012

A continuación se muestra una lista de los parámetros de consulta que están disponibles para este patrón URI. Construir el servicio web a partir de la URL base y los patrones de URI anteriores, luego agregar estos parámetros después del signo de interrogación como separador de consulta (con cada par campo-valor separado por un signo ampersand).
Todos los parámetros son opcionales.

Parametro Valores Permitidos Descripción
id entero Deberá ser un valido id de la reunión.
reuniondoc_id entero Id del documento
nombre cadena Nombre del documento
link cadena Link al archivo asociado al documento
texto cadena Texto del documento
tema cadena Temas vinculados al documento de la reunión
Ej.: Clima, Biodiversidad, Suelo, Educación Ambiental, Sustancias y Productos Químicos, Evaluación de Impacto Ambiental, etc.
tnombre texto Tipo de documento (Acta, Agenda, Informe, Manual, etc).

También es posible adicionar parámetros independientemente del recurso que se está consultando, como los que se muestran a continuación:
Todos los parámetros son opcionales.

Parametro Valores Permitidos Descripción
ws_ordc cadena Nombre del campo a partir del cual se realizará el ordenamiento.
Ej: ws_ordc=fecha_inicio
ws_ordt cadena Tipo de ordenamiento de los datos recuperados.
Valores permitidos:
a (ascendente)
d (descendente)
ws_regi entero Registro inicial a partir del cuál recuperar los datos.
ws_regn entero Número total de regitros a recuperar.
ws_cons cadena Tipo de consulta.
Valores permitidos:
l (Lista: Devuelve un subconjunto de los campos)
d (Detalle: Devuelve la totalidad de los campos del recurso)

URI Ejemplos

Haga Click en los links siguientes para visualizar los resultados de ejemplo
desde cada consulta REST. Seleccione ambos, xml o json para ver cada formato
respectivamente. Copie la URL listada para usar como una referencia.

Encontrar documentos de la reunion con id 2 y la totalidad de los campos
http://www.mercosurambiental.net/ws/reuniondocs.json?id=2&ws_cons=d

Visualiza únicamente los primeros 20 documentos con "plan" en su nombre.
http://www.mercosurambiental.net/ws/reuniondocs.xml?nombre=plan&ws_regn=20

Uso de la API - PHP

Para emplear la API desde PHP utilizamos la libreria cURL que permite conectarse y comunicarse con diferentes tipos de servidores y diferentes tipos de protocolos. cURL hace la petición por medio de HTTP, lo único que debemos hacer es ocuparnos de su resultado que es el valor $decoded->status. En caso de que sea distinto de 200, algo anduvo mal.

Ejemplo JSON

Ejemplo XML

Solución de Problemas

Si usted está teniendo problemas de recuperación de datos, compruebe lo siguiente: