Namespace: RESTful API

RESTful API

Api RESTful GeoBcn proporciona un servei rest de consulta de dades de geocoding. Les respostes del servei estàn encapsulades en el tipus de dada Resposta.

El servei retorna les dades en format JSON i HTML. Per defecte retorna format JSON.

Per obtenir HTML a través del servei cal especificar f=html

Totes les funcions accepten els següents paràmetres que permeten configurar la resposta del servei:

  • f : format sortida. Permet els valors json i html.
  • geometria : Si s'especifica el valor a true, la resposta inclourà la geometria de l'objecte de resposta.
  • extensio : Si s'especifica el valor a true, la resposta inclourà l'extensió en coordenades de l'objecte de resposta.
  • nomesCamps : Serveix per especificar una llista de camps separats per coma. Aleshores la resposta contindrà només aquests camps demanats. Per defecte quan no especifiquem cap camp es dona tota la informació.

Serveis

Adreces(){Array.<Adreça>}

El servei d'adreces proporciona mètodes per obtenir informació d'adreces de la ciutat de Barcelona.

Proporciona 2 tipus de servei:

  • Obtenir adreça per identificador.
  • Cercar adreces per consulta espaial: Geocoding invers i proximitat
URLs de servei
GET geobcn/serveis/territori/adreces/{id}

Retorna l'adreça on id es el seu codi.

GET geobcn/serveis/territori/adreces ? {queryEspaial}

Parametrització per la cerca geoespaial: retorna adreces obtingudes depenent dels paràmetres de query .
En funció dels paràmetres espacificats tindrem els resultats d'un Geocoding invers(sense radi) o bé una proximitat(amb el radi especificat).

Properties
Nom Tipus Argument Valor per defecte Descripció
x decimal

Coordenada x on volem cercar.

y decimal

Coordenada y on volem cercar.

out_proj string

Projecció de sortida.

proj string <optional>
EPSG:23031

projecció de la coordenada.

radi numero <optional>
25

Radi de cerca.

max numero <optional>
5

Número màxim d'adreces.

Vegeu temes relacionats:

Barris(){Array.<Barri>}

Servei per obtenir informació de barris de la ciutat de Barcelona.

URLs de servei
GET geobcn/serveis/territori/barris/

Col·lecció dels barris de la ciutat de Barcelona.

GET geobcn/serveis/territori/barris/{id}

Retorna el barri id es el seu codi.

GET geobcn/serveis/territori/barris ? {queryEspaial}

Parametrització per la cerca geoespaial de barris: retorna el barri que conté la coordenada especificada

Properties
Nom Tipus Argument Valor per defecte Descripció
x decimal

Coordenada x on volem cercar.

y decimal

Coordenada y on volem cercar.

out_proj string

Projecció de sortida.

proj string <optional>
EPSG:23031

projecció de la coordenada.

GET geobcn/serveis/territori/barris ? {queryRc}

Parametrització per cerca per Referència cadastral: retorna el barris que conté la referència cadastral especificada

Properties
Nom Tipus Descripció
rc string

Referència cadastral de 14 on estem cercant el barri.

GET geobcn/serveis/territori/barris ? {queryNom}

Parametrització per cerca per similitut de nom i per districte: retorna els barris que tenen un nom semblant a l'espcificat i que estàn dins el districte especificat.

Properties
Nom Tipus Descripció
nom string

nom pel que es cercaràn els districtes.

id_districte string

id del districte pel que volem cercar.

Vegeu temes relacionats:

Cerca Territori(){ElementsTerritori}

El servei d'adreces proporciona mètodes per obtenir informació general de la ciutat de Barcelona.

Proporciona 1 tipus de servei:

  • Cercar adreces i carrers per consulta de text.
URLs de servei
GET geobcn/serveis/territori ? {query}

retorna els elements de territori que compleixen la query.

Properties
Nom Tipus Descripció
q string

Suggerencia de text. Per exemple "diagonal 220" .

returnVoidLocations boolean

Indica si la resposta contindrà elements sense localització. Defecte: false

Vegeu temes relacionats:

Cruilles(){Array.<Cruilla>}

Servei per obtenir informació de les cruilles dels carrers de la ciutat de Barcelona

URLs de servei
GET geobcn/serveis/territori/cruilles ? {query}

Parametrització per cerca per id_via existent i similitut de nom de la via que creua.

GET geobcn/serveis/territori/cruilles ? {queryNom}.id_via string

id de la via sobre la que es vol cercar la cruïlla.

GET geobcn/serveis/territori/cruilles ? {queryNom}.nom string

nom de la via que cerquem que pugui creuar la via a id_via.

GET geobcn/serveis/territori/cruilles ? {queryNom}.returnVoidLocations boolean

Indica si la resposta contindrà elements sense localització. Defecte: false

Vegeu temes relacionats:

Districtes(){Array.<Districte>}

El servei dóna mètodes per obtenir informació de districtes de la ciutat de Barcelona.

Proporciona 5 tipus de servei, els quals permeten obtenir

  • Tots els districtes.
  • Un districte concret.
  • Aquells districtes dins una consulta espaial, cerca per referència cadastral i per nom.
URLs de servei
GET geobcn/serveis/territori/districtes/

Col·lecció dels districtes de la ciutat de Barcelona.

GET geobcn/serveis/territori/districtes/{id}

Retorna l'adreça on id es el seu codi.

GET geobcn/serveis/territori/districtes ? {queryEspaial}

Parametrització per la cerca geoespaial de districtes: retorna el districte que conté la coordenada especificada

Properties
Nom Tipus Argument Valor per defecte Descripció
x decimal

Coordenada x on volem cercar.

y decimal

Coordenada y on volem cercar.

out_proj string

Projecció de sortida.

proj string <optional>
EPSG:23031

projecció de la coordenada.

GET geobcn/serveis/territori/districtes ? {queryRc}

Parametrització per cerca per Referència cadastral: retorna el districtes que conté la referència cadastral especificada

Properties
Nom Tipus Descripció
rc string

Referència cadastral de 14 on es troba el districte.

GET geobcn/serveis/territori/districtes ? {queryNom}

Parametrització per cerca per similitut de nom: retorna els districtes que tenen un nom semblant a l'espcificat

Properties
Nom Tipus Descripció
nom string

nom pel que es cercaràn els districtes.

Vegeu temes relacionats:

Fulls 1000(){Array.<Full1000>}

El servei de fulls 1000 proporciona mètodes per cercar codis de fulls de cartogràfia de la distribució 1:1000 a la ciutat de Barcelona.

URLs de servei
GET geobcn/serveis/territori/fulls1000/{id}

Retorna el full amb el codi id.

GET geobcn/serveis/territori/fulls1000 ? {queryCerca}

Parametrització per la cerca de fulls 1:1000.

Properties
Nom Tipus Descripció
codi numero

Suggerencia dels codis a cercar semblants.

Vegeu temes relacionats:

Illes(){Array.<Illa>}

Mètodes per opbtenir informació d'illes urbanes de la ciutat de Barcelona

URLs de servei
GET geobcn/serveis/territori/illes/{id}

Retorna la illa on id es el seu codi.

GET geobcn/serveis/territori/illes ? {queryEspaial}

Parametrització per la cerca geoespaial d'illes: retorna la illa que conté la coordenada especificada

Properties
Nom Tipus Argument Valor per defecte Descripció
x decimal

Coordenada x on volem cercar.

y decimal

Coordenada y on volem cercar.

out_proj string

Projecció de sortida.

proj string <optional>
EPSG:23031

projecció de la coordenada.

GET geobcn/serveis/territori/illes ? {queryRc}

Parametrització per cerca per Referència cadastral: retorna la illa que conté la referència cadastral especificada

Properties
Nom Tipus Descripció
rc string

Referència cadastral de 14 on es troba la illa.

GET geobcn/serveis/territori/illes ? {queryCodi}

Parametrització per cerca per similitut de codi: retorna els districtes que tenen un codi semblant a l'espcificat i que pertanyen a un districte determinat.

Properties
Nom Tipus Argument Descripció
codi string <optional>

nom pel que es cercaràn els districtes.

id_districte string <optional>

nom pel que es cercaràn els districtes.

Vegeu temes relacionats:
  • Especificació del tipus de dada Illa
  • Enumeració de les diferents projeccions acceptades pel paràmetre proj
  • Exemple d'una Illa

Mapes de Situació(){image/png|image/jpeg}

El servei de mapes de situació proporciona mètodes per obtenir imatges del mapa en una coordenada donada. Addicionalment, el servei pot afegir a la imatge un marcador al centre.

URLs de servei
GET geobcn/serveis/territori/mapa_situacio ? {querySituacio}

Parametrització per la obtenció de mapes de situació:

Properties
Nom Tipus Argument Valor per defecte Descripció
x decimal

Coordenada x on volem centrar el mapa.

y decimal

Coordenada y on volem centrar el mapa.

out_proj string

Projecció de sortida.

proj geoBCN.CoordSystem <optional>
TRESOR

Sistema de coordenades del punt. Vegi'n mes informació al tipus geoBCN.Mapa.Proj

format string <optional>
png

Format de la imatge demanada. Possibles valors: png o jpg.

scale numero <optional>
500

Escala de visualització del mapa.

icon string <optional>
true

Icona visible al centre. Valors admesos: true (mostra imatge per defecte), false (no mostra cap imatge al centre) o una url que enllaci a una icona.

height numero <optional>
600

Alçada de la imatge resultant. Es obligatori informar width quan s'informa aquest paràmetre.

width numero <optional>
800

Amplada de la imatge resultant. Es obligatori informar height quan s'informa aquest paràmetre.

Vegeu temes relacionats:

Parcel·les(){Array.<Parcella>}

Servei per obtenir informació de parcel·les de la ciutat de Barcelona.

URLs de servei
GET geobcn/serveis/territori/parcelles/{id}

Retorna la parcel·la on id es el seu codi. Aquest es la concatenació del codi d'Illa (5 dígits) + codi de parcel·la (3 dígits)

GET geobcn/serveis/territori/parcelles ? {queryEspaial}

Parametrització per la cerca geoespaial de parceles: retorna la parcel·la que conté la coordenada especificada

Properties
Nom Tipus Argument Valor per defecte Descripció
x decimal

Coordenada x on volem cercar.

y decimal

Coordenada y on volem cercar.

out_proj string

Projecció de sortida.

proj string <optional>
EPSG:23031

projecció de la coordenada.

GET geobcn/serveis/territori/parcelles ? {queryRc}

Parametrització per cerca per Referència cadastral: retorna la parcel·la que conté la referència cadastral especificada

Properties
Nom Tipus Descripció
rc string

Referència cadastral de 14 on estem cercant la parcel·la.

Vegeu temes relacionats:

Portals(){Array.<Adreça>}

El servei de portals proporciona mètodes per cercar adreces que son portal (GPL=1) de la ciutat de Barcelona.

Proporciona 2 tipus de servei:

  • Cercar adreces amb identificador de via + número.
  • Cercar adreces per consulta espaial amb GPL=1: Geocoding invers i proximitat
URLs de servei
GET geobcn/serveis/territori/portals ? {queryCerca}

Parametrització per la cerca d'adreces: geocodificació.

Properties
Nom Tipus Descripció
id_via numero

Identificador únic del carrer on volem cercar el portal.

numero string

Número o interval de números (per exemple: 220-250) pels que volem cercar portals. També accepta número + lletra (per exemple: 220A-250B).

GET geobcn/serveis/territori/portals ? {queryEspaial}

Parametrització per la cerca geoespaial: retorna adreces obtingudes depenent dels paràmetres de query .
En funció dels paràmetres espacificats tindrem els resultats d'un Geocoding invers(sense radi) o bé una proximitat(amb el radi especificat).

Properties
Nom Tipus Argument Valor per defecte Descripció
x decimal

Coordenada x on volem cercar.

y decimal

Coordenada y on volem cercar.

out_proj string

Projecció de sortida.

proj string <optional>
EPSG:23031

projecció de la coordenada.

radi numero <optional>
25

Radi de cerca.

max numero <optional>
5

Número màxim d'adreces.

Vegeu temes relacionats:

Seccio Censal(){Array.<SeccioCensal>}

Mètodes per obtenir informació de les seccions censals de la ciutat de Barcelona

URLs de servei
GET geobcn/serveis/territori/seccionscensals ? {query}

Parametrització per la cerca a partir del codi de secció. Es retornen aquelles seccions censals que el seu codi es semblant a l'especificat.

Properties
Nom Tipus Descripció
id_filtre string

Filtre de semblança per identificador únic de secció censal.

codi string

Número de secció censal dins un Districte.

districte string

Filtre de codi de districte de la secció cercada. Les seccions censals retornades estarán restringides al districte especificat.

barri string

Filtre de codi de barri de la secció cercada. Les seccions censals retornades estarán restringides al barri especificat.

codi_aeb string

Filtre de semblança per codi AEB -únic- de secció censal.

Vegeu temes relacionats:

Tipus de Vies(){Array.<TipusVia>}

Mètodes per obtenir informació dels Info del tipus de dada Tipus de Via de la ciutat de Barcelona

URLs de servei
GET geobcn/serveis/territori/tipusvies/{id}

tipus de via que té id per codi.

GET geobcn/serveis/territori/tipusvies ? {parametres}

tipus de via filtrades depenent dels paràmetres de query .

Properties
Nom Tipus Descripció
nom string

Nom de la via semblant .

Vegeu temes relacionats:

Vies(){Array.<Via>}

Mètodes per opbtenir informació les vies de la ciutat de Barcelona

URLs de servei
GET geobcn/serveis/territori/vies/{id}

Retorna la via que té id per codi.

GET geobcn/serveis/territori/vies ? {parametres}

vies obtingudes depenent dels paràmetres de query .

Properties
Nom Tipus Descripció
nom string

Nom semblant al carrer que volem cercar.

id_tipus_via string

Identificador del tipus de via.

returnVoidLocations boolean

Indica si la resposta contindrà elements sense localització. Defecte: false

Vegeu temes relacionats: