Sonraí XML (dímholta)

NB: Tá leagan 1.0 de chomhéadan feidhmchláir (API) Logainm, ar comhéadan REST JSON é, seolta anois. Dá bhrí sin, tá an comhéadan XML dímholta anois. Cuirfear an comhéadan XML as feidhm i ndiaidh 31 Nollaig 2020. Moltar d’úsáideoirí an doiciméadacht chuí a bhaineann leis an API nua a bhreithniú agus súil acu aistriú chuig an gcomhéadan JSON.

Tá sonraí logainm.ie ar fáil i bhformáid XML atá inléite ag ríomhairí. Tá fáilte roimh aon duine úsáid a bhaint as na sonraí seo chun a gcuid feidhmchlár féin a chruthú nó chun sonraí logainmníochta a tharraingt isteach i bhfeidhmchláir ar ann dóibh cheana.

Is féidir na sonraí seo a athúsáid faoi théarmaí an cheadúnais Creative Commons Attribution 4.0 International (CC BY 4.0).

Conas teacht ar na sonraí

Tá nasc ar fáil ag bun gach leathanach sonraí áite ar logainm.ie lena bhfaighidh tú na sonraí céanna atá ar an leathanach sin ach iad i bhformáid XML. Nó is féidir leat iarratas HTTPS a sheoladh chuig URL ar nós https://www.logainm.ie/xml/1384607 agus gheobhaidh tú na sonraí céanna, ach an uimhir sa URL a athchur le huimhir aitheantais na háite atá uait. Tá uimhir aitheantais uathúil ar gach áit i mbunachar logainm.ie agus bíonn an uimhir sin luaite i seoladh na háite i gcónaí, mar shampla:

https://www.logainm.ie/ga/1384607 — eolas faoi áit uimhir 1384607 i nGaeilge
https://www.logainm.ie/en/1384607 — eolas faoi áit uimhir 1384607 i mBéarla
https://www.logainm.ie/xml/1384607 — eolas faoi áit uimhir 1384607 in XML

Na sonraí a thuiscint

Doiciméad beag XML atá ar fáil le haghaidh gach áite agus tá struchtúr mar seo ann:

<place id="1384607” permalink="https://www.logainm.ie/1384607.aspx">
	<source lang="ga">Bunachar Logainmneacha na hÉireann, logainm.ie</source>
	<source lang="en">Placenames Database of Ireland, logainm.ie</source>
	...
</place>

Sa chlib <place> tá na haitreabúidí seo ar fáil:

@id — uimhir aitheantais uathúil na háite seo.
@permalink — URL ar féidir daoine a sheoladh chuige chun tuilleadh eolais a fháil i dtaobh na háite seo. Déanfaidh sé seo atreorú uathoibríoch chuig leagan Gaeilge nó Béarla den leathanach sonraí áite.

Más rud gur iarr tú de thaisme áit nach ann di, gheobhaidh tú doiciméad XML mar seo ina áit:

<place id="534525234” nonexistent="yes"/>

Nó (sa chás go bhfuil taifead na háite sin tar éis a chumsctha le taifead eile inár mbunachar):

<place id="534525234” nonexistent="yes” replacedBy="654644348"/>

Taobh istigh den chlib <place> tá na clibeanna seo a leanas ar fáil:

`<name>`

Insíonn an chlib seo cén t-ainm atá ar an áit. Bíonn dhá ainm ar áiteanna in Éirinn de ghnáth, ceann i nGaeilge agus ceann i mBéarla, agus dá réir sin beidh dhá chlib <name> i ngach doiciméad XML. Bíonn eisceachtaí ann freisin, áfach, agus tarlóidh sé nach mbeidh ach clib amháin nó go mbeidh breis is dhá cheann. Seo na haitreabúidí a gheofar sa chlib:

@lang — ga nó en le tabhairt le fios cén teanga ina bhfuil an t-ainm.
@wording — an t-ainm féin, mar shampla Baile Átha Cliath nó Dublin.
@genitive — foirm don tuiseal ginideach den ainm, más ainm Gaeilge. Más ainm Béarla, níl an aitreabúid seo ar fáil.
@isMain — yes nó no le tabhairt le fios an é seo an príomhainm atá ar an áit. Níl tábhacht leis an aitreabúid seo ach i gcás áiteanna a bhfuil breis is ainm amháin orthu sa teanga chéanna.
@acceptabilityGA agus @acceptabilityEN — lipéad gairid i nGaeilge agus i mBéarla a insíonn cén stádas taighde agus deimhnithe atá ar an ainm, mar shampla ainm deimhnithe/validated name nó ainm stairiúil/historical name. Féach Nótaí inghlacthachta le haghaidh mhíniú na lipéad.

`<type>`

Insíonn an chlib seo cén chatagóir áite atá i gceist: cathair, contae, baile fearainn etc. Féach Catagóirí logainmneacha le haghaidh tuilleadh eolais. Beidh clib amháin mar seo ag gach áit de ghnáth, ach tá eisceachtaí ann. Aitreabúidí:

@id — aitheantóir na catagóire, mar shampla CTH.
@titleGA agus @titleEN — teideal na catagóire i nGaeilge agus i mBéarla, mar shampla cathair/city.

`<isIn>`

Insíonn an chlib seo cé hiad na haonaid riaracháin (contaetha, paróistí dlí etc.) a bhfuil an áit seo iontu. Crostagairtí chuig áiteanna eile i mbunachar logainm.ie iad seo. I gcás fhormhór na n-áiteanna sa bhunachar, bíonn contae, barúntacht, paróiste dlí, agus baile fearainn nó toghroinn luaite. Aitreabúidí:

@typeID, @typeTitleGA agus @typeTitleEN — catagóir an aonaid riaracháin.
@placeID, @nameGA agus @nameEN — ainm an aonaid riaracháin.
@permalink — URL ar féidir daoine a sheoladh chuige chun tuilleadh eolais a fháil i dtaobh na háite seo. Déanfaidh sé seo atreorú uathoibríoch chuig leagan Gaeilge nó Béarla den leathanach sonraí áite.

`<property>`

Clib a insíonn faoi airíonna éagsúla atá ar an áit seo, má tá a leithéid ann. D’fhéadfadh níos mó ná ceann amháin, nó ceann ar bith, a bheith ag áit. Aitreabúidí:

@id — Más G, tá an áit sa Ghaeltacht. Más TÉ, tá an áit i dTuaisceart Éireann. Más PO, tá postoifig san áit nó bhí tráth.
@extent — Más all, baineann an airí leis an áit ar fad. Más part, ní bhaineann an airí ach le cuid den áit.

`<link>`

Clib ina bhfuil nasc chuig leathanach gréasáin seachtrach ar a bhfuil eolas faoin áit chéanna, mar shampla Vicipéid, Geonames agus Placenamesni.org. D’fhéadfadh níos mó ná ceann amháin, nó ceann ar bith, de na clibeanna seo a bheith ag áit. Aitreabúidí:

@linkType — Leasainm an tsuímh atá i gceist, mar shampla WikipediaEn don leagan Béarla de Vicipéid.
@linkTarget — An URL féin.

`<owlSameAs>`

Clib ina bhfuil URI acmhainne Semantic Web a thagraíonn don áit chéanna. D’fhéadfadh níos mó ná ceann amháin, nó ceann ar bith, de na clibeanna seo a bheith ag áit. Aitreabúidí:

@uri — An URI féin.

`<grid>`

Suíomh geografach na háite san Eangach Náisiúnta. Suas le ceann amháin a bhíonn ag áit, ach d’fhéadfadh dhá cheann bheith luaite más abhainn atá i gceist (tús agus deireadh).

@square — Cearnóg na heangaí ina bhfuil an áit.
@easting — Oirlíne na háite sa chearnóg.
@northing — Tuaidhlíne na háite sa chearnóg.

`<geo>`

Suíomh geografach na háite agus é curtha in iúl mar phéire de dhomhanfhad agus de dhomhanleithead.

@lat agus @lon — Domhanfhad agus domhanleithead na háite. Más áit í a bhfuil dhá phéire comhordanáidí aici, mar shampla abhainn, tá @lat2 agus @lon2 luaite freisin.
@isAccurate — An gcreidtear go bhfuil na comhordanádí seo cruinn (“yes”) nó garbh (“no”). Bíonn comhordanáidí garbha i gceist má fuarthas iad le heachtarshuíomh ó áiteanna eile in aice.