Kustuta kaust

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

Päringu parameetrid

Päringus ei tohi viidata ühele ja samale kaustale mõlema parameetriga (id, path), st. tuleb kasutada kas parameetrit id või path kuid mitte mõlemat.

Päringus tohib kasutada mõlemat parameetrit samaaegselt kui viidatakse erinevatele kaustadele. Näiteks kui soovitakse eemaldada kaust mille ID on 12 ja teine kaust mille teekond on /Test, siis tuleks päringus saata id=12&path=/Test.

Parameeter Tüüp Kirjeldus
id Integer. Eemaldatava kausta ID. Antud parameetrit võib kasutada päringus mitu korda. Näiteks kui soovitakse eemaldada mitu kausta korraga mille ID'd on 12,13,34, siis tuleks päringus saata id=12&id=13&id=34.
path String. Eemaldatava kausta teekond. Antud parameetrit võib kasutada päringus mitu korda. Näiteks kui soovitakse eemaldada mitu kausta korraga mille nimetused on Test1,Test2,Test3, siis tuleks päringus saata path=/Test1&path=/Test2&path=/Test3.

Vastus

Väli Tüüp Kirjeldus
response
String.
Väärtused 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.

Veakoodid

Nimetus Kirjeldus
INVALID_FOLDER_PATH Parameeter path on vigane.
NO_FOLDER_ID_PATH Parameetritega id ja path pole määratud ühtegi kausta.
INVALID_FOLDER_ID_PATH Parameetriga id või path määratud kausta ei leitud, või viitavad mõlemad samale kaustale.

Näidispäring

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

id=18318&path=%2FTest5&path=%2FTest6&acc_key=abo5k66xjrjfohkjls71&sig=0vIuEtw9Rwi%2FFXevSP6Jra9HXG0%3D

Näidisvastus

HTTP/1.1 200 OK
Date: Fri, 08 Apr 2011 12:20:56 GMT
Server: Apache
Content-Type: application/json; charset=UTF-8
Content-Length: 17

{"response":"OK"}
 
Eesti Arhivaar OÜ © 2011. Kõik õigused on kaitstud. Tegevusluba nr. 000110.