Kausta informatsioon

https://api.arhivaar.ee/api/v0_4/folder/info.html

Päringu parameetrid

Parameeter Tüüp Kirjeldus
id
Vabatahtlik. Integer.
Kausta ID mille informatsiooni soovitakse. Puuduva väärtuse puhul on selleks juurkaust.

Vastus

Väli Tüüp Kirjeldus
response
String.
Väärtus OK või ERROR.
responseDescription
Error.
Sisaldab ühte veakoodi, vaadake allpool. See väli on tagastatud ainult juhul, kui päringu tegemisel tekkis viga, st response väli sisaldab väärtust ERROR.
folder
Folder.

Veakoodid

Nimetus Kirjeldus
INVALID_FOLDER_ID
Parameeter id on vigane.
FOLDER_NOT_EXISTS Parameetrile id vastavat kausta ei leitud.

Näidispäring

POST /api/v0_4/folder/info.html HTTP/1.1
Content-Length: 72
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Host: api.arhivaar.ee
User-Agent: Test Client

id=22351&acc_key=abo5k66xjrjfohkjls71&sig=vi20jML3WU8nJud8byNzd32qWck%3D

Näidisvastus

HTTP/1.1 200 OK
Date: Fri, 17 Jun 2011 13:32:41 GMT
Server: Apache
Content-Length: 346
Content-Type: application/json;charset=UTF-8

{
    "response":"OK",
    "folder": {
        "index":"TT123",
        "month":4,
        "year":2011,
        "description":"Test folder.",
        "keywords":"test, hello",
        "expireDate":1308344400000,
        "id":22351,
        "parentId":19565,
        "name":"Test",
        "createdDate":1306934924445,
        "root":false
    }
}
 
Eesti Arhivaar OÜ © 2011. Kõik õigused on kaitstud. Tegevusluba nr. 000110.