Where

versiunea 6, actualizată de aurelian în 08 Sep, 2009

Privire de ansamblu

/api/where parcurge un text dat extrăgând numele locurilor la care se face referire.

Apel

POST /api/reverse

Parametrii:

parametru descriere valore posibilă valoare implicită
api_key cheia de acces string –
text textul introdus string, min. 64-max. 1024 –
page pagina int 1
version versiunea dorită 0.5 0.5
callback javascript callback numele unei functii javascript ce va fi apelată având ca parametru raspunsul. (functionează doar pentru format=json) –

Atenție!

Spre deosebire de /api/locate sau /api/reverse, pentru apelarea serviciului /api/where se va folosi metoda POST.
Formatul răsupunsului se poate solicita doar folosind headerul Accept corespunzător.

Exemplu

curl \
-H "Accept: application/xml" \
-d "api_key=b03c630fab936f4dc501c114f29f4750" \
--data-urlencode "text=Un bărbat de 59 de ani, din localitatea clujeană Şigău, a murit la câteva ore după ce a căzut dintr-un copac." \
http://ondi.ro/api/where

Răspuns

Raspunsul este identic cu /api/locate având aceleași două secțiuni: header și places.

  1. header informații generice despre serviciu, și conține:
    • code, codul de răspuns: 10 OK, 20-29 WARNING, 30-39 ERROR
    • results, numărul de rezultate găsite
    • version, versiunea folosită (0.4)
    • service, metoda apelata si parametrii primiti
    • page, pagina curenta
    • per_page, numarul de rezultate pe pagina
    • pages, numarul total de pagini
  2. places este o listă de place, fiecare conținând:
    • name, numele locației (format: tip nume)
    • parent, numele locației părinte
    • county, județul
    • kind, tipul locației
    • updated, data ultimei actualizări
    • distance, distanta in kilometrii fata de centrul specificat
    • latitude
    • longitude

kind: valori posibile:

kind ce înseamnă?
4 Municipiu reședință de județ
16 Municipiu
32 Oraș
64 Cartier
256 Localitate reședință de comună
512 Localitate

code: valori posibile:

code semnificație
10 OK
21 Warning: ApiKey-ul folosit nu poate fi validat
31 Error: ApiKey invalid
32 Error: Versiune Invalidă
33 Error: ApiKey dezactivat
35 Error: Text prea scurt/lung (minim 64 caractere, maxim 1024)
37 Error: Limita accesari / zi a fost atinsa
38 Error: Contul necesita revalidare