Spēles
Receive actual information in your e-mail!
API dokumentācija
Integrācijas
Cita informācija
API documentation in English
Pasākumu sadaļas API
Saturs
Pasākumu sadaļas API ļauj iegūt datus par draugiem.lv pasākumu sadaļā esošajiem pasākumiem.
1. Pieprasījuma formāts
XML ir pieejams adresē https://www.draugiem.lv/events/api/, padodot nepieciešamos parametrus kā HTTP GET vērtības.
Pieprasījuma parametri:
- feed
- pieprasījuma veids. Atbalstītie pieprasījumu veidi aprakstīti zemāk.
- format
- datu formāts. Atbalastītie datu formāti: xml, json
2. Kļūdu ziņojumi
Ja datu apstrādes laikā notikusi kļūda, vai nav iespējams apstrādāt pieprasījumu, tiek atgriezta šāda konstrukcija:
<error> <code>1</code> <message>Missing or invalid country identifier.</message> </error>
Ja datu apstrāde noritējusi veiksmīgi, atgrieztajā XML struktūrā būs šī konkstrukcija, ar <code>0</code>.
3. Kļūdu kodu atšifrējums
code | message |
---|---|
2 | Trūkst vai neatbalstāms pieprasījuma veids (vērtība feed) |
3 | Nav padots pasākuma ID. |
4 | Pasākums neeksistē. |
5 | Pieeja liegta. |
6 | Pieprasīts nekorekts datu formāts |
4. Pasākuma ieraksta formāts
Lielākā daļa pieprasījumu atgriež konstrukciju, kas apraksta pasākuma ierakstu. Piemērs:
<event> <id>323504</id> - draugiem.lv pasākuma ID <title>Ar buru pār jūru</title> - pasākuma nosaukums <created>1280902762</created> - pasākuma izveidošanas datums (nav pasākuma norises datums!) <link>https://www.draugiem.lv/events/arburuparjuru/</link> - saite uz pasākumu <picture_a4>https://i4.ifrype.com/business/323/504/v3/p323504.jpg</picture_a4> - pasākuma "plakāta" bilde <picture_icon>https://i4.ifrype.com/business/323/504/v3/sm_323504.jpg</picture_icon> - 50x50 ikona <picture_large>https://i4.ifrype.com/business/323/504/v3/l_323504.jpg</picture_large> - lielā izmēra bilde <description> - pasākuma apraksts Liepājnieks Jānis Preiss, godalgotais latviešu ūdens sportists, ir gatavs pieņemt jaunu izaicinājumu – šķērsot vienatnē Baltijas jūru uz vindsērfinga dēļa (no Liepājas līdz Visbijai)! Šis brauciens būs latviešu spēka, drosmes, izturības un uzņēmības pārbaude un pierādījums, ka latvieši ir tauta, kas seko līdzi jaunajam un gatavi uzņemties aizvien nebijušus izaicinājumus.Seko līdzi Jāņa gaitām un piedalies braucienā ar savām domām un labajiem vēlējumiem! </description> <dates> - pasākuma norises datumi un vietas (var būt vairākas) <date> <start>1282647600</start> - sākuma laiks <region id="19" lat="56.5247658" lng="21.0286403">Liepāja</region> - norises reģions <place id="1053" lat="56.5817063" lng="21.0086059" address="Rīgas iela 5">Viesnīca "Zvejnieks"</place> - norises vieta </date> </dates> <categories> - pasākuma kategorija <category id="8">Mūzika</category> </categories> <participants>126</participants> </event>
5. Pieprasījums "actual"
https://www.draugiem.lv/events/api/?feed=actual
Atgriež sarakstu ar "aktuālajiem" pasākumiem. Aktuālie pasākumi ir draugiem.lv administrācijas izvēlēties pasākumi.
6. Pieprasījums "item"
https://www.draugiem.lv/events/api/?feed=item&id=323504
Atgriež datus par konkrētu pasākumu.
Obligātie lauki: id - draugiem.lv pasākuma ID.
7. Pieprasījums "categories"
https://www.draugiem.lv/events/api/?feed=categories
Atgriež sarakstu pasākumu kategorijām.
8. Pieprasījums "search"
https://www.draugiem.lv/events/api/?feed=search&country=lv
Ļauj meklēt pasākumus pēc kritērijiem.
Iespējamie lauki:
- city
- pilsēta (piemēram, "Rīga").
- catid
- kategorijas ID.
- start
- sākuma datums (unix timestamp).
- search
- meklēšanas kritērijs.
- page
- lapa (numurācijas sākas no 1).
- rpp
- rezultātu skaits lapā (pēc noklusējuma 10).
Neviens lauks nav obligāts, taču pieprasījumā jābūt vismaz vienam. Bez pašiem pasākuma ierakstiem, atgriež meklēšanas rezultātu konstrukciju:
<search> <total>25520</total> - kopā atrastie rezultāti <displayed>10</displayed> - rezultātu skaits, kas attēlots <page>2</page> - tekošā lapa (sākas no 1) <rpp>10</rpp> - rezultātu skaits lapā <pages>2552</pages> - kopējais lapu skaits </search>