Liiguta dokument kausta

https://api.arhivaar.ee/api/v0_4/document/move.html

Päringu parameetrid

Parameeter Tüüp Kirjeldus
srcDocId Kohustuslik. Integer. Dokumendi ID mida soovitakse liigutada kausta. Antud parameetrit võib kasutada päringus mitu korda. Näiteks kui soovitakse liigutada mitut dokumenti korraga, mille ID'd on 12,13,34 siis tuleks päringus saata srcDocId=12&srcDocId=13&srcDocId=34.
destFolderId Vabatahtlik. Integer Kausta ID millesse soovitakse liigutada dokumenti. Puuduva väärtuse puhul on selleks juurkaust.

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_DOC_ID Parameeter id on vigane.
INVALID_DEST_FOLDER_ID Parameeter destFolderId on vigane.
FOLDER_NOT_EXISTS Parameetrile destFolderId vastavat kausta ei leitud.

Näidispäring

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

srcDocId=31905&srcDocId=31906&srcDocId=31907&acc_key=abo5k66xjrjfohkjls71&sig=ec8g6y0molVDubLoQsN0Aaaf4aE%3D

Näidisvastus

HTTP/1.1 200 OK
Date: Fri, 08 Apr 2011 13:38:14 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.