Erregistroaren API
API baten bidez (Application Programming Interface) bere datu-basean gordetako hirigintza espedienteen datuetara sarbidea ematen du. Dokumentu honek eskeintzen den funtzionaltasuna deskribatzen du eta datu hauek erabiltzen dituzten tresnak sortu nahi dituzten programatzaileentzat lagungarri izatea espero du.
APIren URL basea
Dokumentu honetan agertzen diren URL guztiak, API kokatuta dagoen zerbitzariaren oinarrizko URLan aplikatzen dira
https://w390w.gipuzkoa.net:443/WAS/CORP/DUERegistroPlaneamientoWEB/apiIrteerako formatua
APIk datuak JSON formatuan erakusten ditu.
HTTP egoera kodeak
APIk HTTP egoera kode hauek itzultzen ditu eskaera baterako:
- 200 OK: Dena ondo joan da.
- 400 Bad request: Eskaera gaizki eginda edo osatu gabe dago.
- 404 Not Found: Espedientea edo udalerria ezin izan dira aurkitu. Bilaketak ematzarik aurkitzen ez duenetan ere erabiltzen da.
- 500 Internal Server Error: Gure kodean barneko errore bat izan da. Mesedez, bidali e-mail bat zer egiten ari zinen azalduz, lehenbailehen konpon dezagun.
Espedienteen bilaketa
Bilaketa irizpidearen arabera aurkitu diren espediente guztien zerrenda ateratzen du.
URL
{record}/{cod_archivo}
{record}/{?municipality=municipio}
{record}/{?checking_date=año}
{record}/{?search=patron_busqueda}
Parametroak
- cod_archivo: Hautazkoa. Erregistroko inskripzio kodea. Adibidez, GHE-650
- municipality: Hautazkoa. Bilaketa egin nahi den udalerriaren izena. Adibidez, Errenteria
- checkin_date: Hautazkoa. Bilaketa egin nahi den urtea. Adibidez, 2006.
- search: Hautazkoa. Bai espedientearen tituluan, bai bere edukian bilatu nahi den hitz askea.
Itzulitako objektua
Espedientearen objektuaz osatutako hurrenkera:
- id: Espedientearen kodea.
- registration-number: Espedientearen inskripzio zenbakia.
- title: Espedientearen titulua.
- area: Espedienteak eragina duen eremua.
- checkin-date: Espedientearen sarrera data.
- inscription-date: Espedientearen inskripzio data.
- municipality: Espedientearen udalerria.
- links: URLak espedientearen dokumentu teknikora eta akordiora, hau dagoenean.
Eskaeraren adibideak
https://w390w.gipuzkoa.net:443/WAS/CORP/DUERegistroPlaneamientoWEB/api/record/GHE-650
https://w390w.gipuzkoa.net:443/WAS/CORP/DUERegistroPlaneamientoWEB/api/record?search=PLAN GENERAL
Erantzunaren adibideak
$ curl https://w390w.gipuzkoa.net:443/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": "https://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": "https://b5m.gipuzkoa.eus/planeamiento/GHE-308/INDICE_GHE-308.pdf"
}
]
}