Päringud

Protokollis on mainitud mõned tüübid, mille väärtused on järgmised:

Tüüp Kirjeldus
Date Arv millisekundeid möödunud alates 1970-01-01 00:00:00 UTC.
Boolean Sobivad väärtused on true või false.

Protokolli päringu kirjeldus

API päringud tehakse kujul

https://api.arhivaar.ee/api/<versioon>/<service>.html

kusjuures <versioon> on protokolli versioon (nt. v0_3), <service> on päringu teenuse nimi.

Päringu sisu peab olema url kodeeritud tüüpi (Content-type: application/x-www-form-urlencoded) juhul, kui kirjelduses pole teisiti öeldud. Näiteks, dokumendi üleslaadimisel kasutatakse multipart/form-data sisu tüüpi.

Protokolli vastuse kirjeldus

Päringu vastus on alati JSON kodeeringu kujul. Vastuses võivad olla ka päringule spetsiifilised objektid. Iga päringu vastuses on alati olemas järgnevad väljad:

Väli Tüüp Kirjeldus
response String Võimalikud väärtused: OK või ERROR. Juhul, kui päring oli õnnelikult teostatud, väärtuseks on OK. Vastasel juhul on ERROR.
responseDescription Error Objekt, mis eksisteerib ainult vigase päringu puhul (kui response oli ERROR).
 
Eesti Arhivaar OÜ © 2011. Kõik õigused on kaitstud. Tegevusluba nr. 000110.