API del registro

Se proporciona acceso a los datos de los expedientes urbanísticos almacenados en su base de datos a traves de un API (Application Programming Interface). Este documento describe la funcionalidad ofrecida y espera servir de ayuda a los programadores que deseen contruir herramientas que hagan uso de estos datos.

URL base de la API

Todas las URLs que aparecen en este documento se aplican sobre la URL base del servidor donde se aloja la API.

http://w390w.gipuzkoa.net:80/WAS/CORP/DUERegistroPlaneamientoWEB/api

Formato de salida

La API expone los datos en representacion JSON

Códigos de estado HTTP

El API devuelve los siguientes códigos de estado HTTP para una petición:

  • 200 OK: Todo ha ido bien
  • 400 Bad request: La petición está mal formada o es incompleta
  • 404 Not Found: El expediente o el municipio no se han podido encontrar. También se utiliza cuando la búsqueda no devuelve ningún resultado.
  • 500 Internal Server Error: Se ha producido un error interno en nuestro código. Por favor, envíanos un email contando que es lo que estabas haciendo para que podamos subsanarlo.

Búsqueda de Expedientes

Devuelve una lista de todos los expedientes que se han encontrado según el criterio de búsqueda.

 

URL

{record}/{cod_archivo}
{record}/{?municipality=municipio}
{record}/{?checking_date=año}
{record}/{?search=patron_busqueda}

 

Parámetros

  • cod_archivo: Opcional. Código de inscripción en el registro. Ejemplo. GHE-650
  • municipality: Opcional. Nombre del municipio en el cuál se quiere realizar la búsqueda. Ejemplo. errenteria
  • checkin_date: Opcional. Año en el cuál se quiere realizar la búsqueda. Ejemplo: 2006.
  • search: Opcional. Término libre que se desea buscar tanto en el título del expediente como en su contenido.

 

Objeto devuelto

Un array formado por el objeto expediente:

  • id: Código del expediente
  • registration-number: Número de Inscripción del expediente
  • title: Título del expediente
  • area: Ámbito al que afecta el expediente
  • checkin-date: Fecha de entrada del expediente.
  • inscription-date: Fecha de inscripción del expediente.
  • municipality: Municipio del expediente.
  • links: URLs al documento técnico del expediente y al acuerdo cuando éste exista.

 

Ejemplos de petición

http://w390w.gipuzkoa.net:80/WAS/CORP/DUERegistroPlaneamientoWEB/api/record/GHE-650

http://w390w.gipuzkoa.net:80/WAS/CORP/DUERegistroPlaneamientoWEB/api/record?search=PLAN GENERAL

http://w390w.gipuzkoa.net:80/WAS/CORP/DUERegistroPlaneamientoWEB/api/ target="_blank">record?checkin_date=2012

http://w390w.gipuzkoa.net:80/WAS/CORP/DUERegistroPlaneamientoWEB/api/record?municipality=TOLOSA&search=PLAN GENERAL&checkin_date=2010

 

Ejemplos de respuesta

$ curl http://w390w.gipuzkoa.net:80/WAS/CORP/DUERegistroPlaneamientoWEB/api/record?municipality=TOLOSA&search=PLAN%20GENERAL

 

{
    "resultadoBusqueda": [
        {
            "id": "3998",
            "registration_number": "216",
            "title": "PLAN GENERAL DE ORDENACION URBANA.",
            "area": "TOLOSA",
            "checkin_date": "2009-03-06",
            "inscription_date": null,
            "municipality": "TOLOSA",
            "links": "http://b5m.gipuzkoa.eus/planeamiento/GHE-216/INDICE_GHE-216.pdf"
        },
        {
            "id": "4269",
            "registration_number": "308",
            "title": "MODIFICACION DEL PLAN GENERAL DE ORDENACION URBANA RELATIVA AL SUBAMBITO \"14.3 BERAZUBI IKASTETXEA\"",
            "area": "TOLOSA",
            "checkin_date": "2010-05-14",
            "inscription_date": null,
            "municipality": "TOLOSA",
            "links": "http://b5m.gipuzkoa.eus/planeamiento/GHE-308/INDICE_GHE-308.pdf"
        }
    ]
}