Para recuperar los Planes disponibles, deberá utilizar las siguientes URI:
Base URL |
---|
https://siif.bosquesnativos.net.ar/ws |
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
.
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: ?anio=2016 ?anio=2015|2018 |
Decimal | El tipo esperado es un decimal y admite valores >0 hasta con 2 decimales.
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: ?superficie=10.5 ?superficie=5.45|12 |
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: ?profesional=gomez ?profesional=gomez|gutierrez|perez |
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=2016-04-01 ?fecha=2016-04-01 | 2018-08-30 ?fecha=20014|2018 |
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 |
---|---|---|
cod | cadena | Deberá ser un valido ID de Plan. |
anio | entero | Año de convocatoria. |
provincia | cadena | Provincia del Plan. |
departamento | cadena | Departamento del Plan. |
tipo | cadena | Tipo del Plan Valores permitidos: PC, PM, PF, PI, PCUS. |
duracion | entero | Duración en años del Plan |
estado | cadena | Estado del Plan Valores permitidos: Ingreso de datos, En Revisión, Dado de alta, Dado de Baja, Finalizado |
fecha | fecha | Fecha de acto administrativo. |
profesional | cadena | Profesional vinculado al Plan |
titulares | cadena | Titulares vinculados al Plan |
titulares_cuit | cadena | CUIT de los titulares |
superficie | decimal | Superficie del Plan en hectareas |
cant_poa | entero | Cantidad de POA definidos en el Plan |
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_orden | cadena | Nombre del campo a partir del cual se realizará el ordenamiento. Se debe anteponer un simbolo + para un ordenamiento ascendente o - para uno descendente De no ingresar un simbolo de ordenamiento se toma por defecto ascendente. Ej: ws_orden=+anio,-cod |
ws_regi | entero | Registro inicial a partir del cuál recuperar los datos. Por defecto 0, que se considera el registro inicial. |
ws_regn | entero | Número total de regitros a recuperar. Por defecto 10 registros. |
ws_cons | cadena | Tipo de consulta. Valores permitidos: l (Lista: Devuelve un subconjunto de los campos. Valor por defecto.) d (Detalle: Devuelve la totalidad de los campos del recurso) |
ws_campos | cadena | Campos a recuperar separados por coma. |
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
Para emplear la API desde Jquery utilizamos el método $.ajax() para consumir el servicio. Si se tiene éxito se asignara el json recibido al objeto "ws". Luego lo único que debemos hacer es recorrer cada elemento del resultado y en este caso se incorporan al elemento div.ws.
Ejemplo JSON
Si usted está teniendo problemas de recuperación de datos, compruebe lo siguiente: