Muuda kausta

Veateate puhul ei tehta kaustale ühtegi muudatust.

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

Päringu parameetrid

Parameeter Tüüp Kirjeldus
id Kohustuslik. Integer. Muudetava kausta ID.
changeType Kohustuslik. String. Muudetav atribuut, kehtivad väärtused on NAME, INDEX, MONTH, YEAR, DESCRIPTION, KEYWORDS või EXPIRE_DATE.

Antud parameetrit võib kasutada päringus mitu korda. Näiteks kui soovitakse muuta kausta nimetust (name) ja kirjeldust (description) siis tuleks päringus saata changeType=NAME&changeType=DESCRIPTION&name=Test&description=Test+kirjeldus.
name Vabatahtlik. String. Kausta nimetus. Tähemärke ei tohi olla rohkem kui 200. Nimetus ei tohi sisaldada järgnevaid tähemärke: '/ \ : * ? < > " | '.
index Vabatahtlik. String. Metaandmete tähise väli. Tähemärke ei tohi olla rohkem kui 150.
month Vabatahtlik. Integer. Metaandmete kuu väli. Sobivad väärtused on 1-12 (kaasa arvatud).
year Vabatahtlik. Integer. Metaandmete aasta väli.
description Vabatahtlik. String. Metaandmete kirjelduse väli. Tähemärke ei tohi olla rohkem kui 250.
keywords Vabatahtlik. String. Metaandmete märksõnade väli. Tähemärke ei tohi olla rohkem kui 250.
expireDate Vabatahtlik. Date Kausta aegumiskuupäev. Kausta kehtivuse aegumisel antakse ettevõttele sellest teada. Aegumiskuupäeva eemaldamiseks ei tohi seda parameetrit päringus esineda, näiteks changeType=EXPIRE_DATE.

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.

Veakoodid

Nimetus Kirjeldus
INVALID_FOLDER_ID Parameeter id on vigane.
INVALID_CHANGE_TYPE Parameetrile changeType ei ole omistatud ühtegi väärtust.
INVALID_FOLDER_NAME Parameeter name puudub või koosneb keelatud tähemärkidest.
INVALID_FOLDER_NAME_LENGTH Parameeter name ületab määratletud tähemärkide arvu.
INVALID_FOLDER_INDEX Parameeter index ületab määratletud tähemärkide arvu.
INVALID_FOLDER_MONTH Parameetrile month on omistatud vigane väärtus.
INVALID_FOLDER_YEAR Parameetrile year on omistatud vigane väärtus.
INVALID_FOLDER_DESCRIPTION Parameeter description ületab määratletud tähemärkide arvu.
INVALID_FOLDER_KEYWORDS Parameeter keywords ületab määratletud tähemärkide arvu.
FOLDER_EXISTS Parameetriga name kaust on juba olemas.
FOLDER_NOT_EXISTS Parameetrile id vastavat kausta ei leitud.
PLUGIN_REMINDER_NOT_INSTALLED Säilitustähtaja meeldetuletuse plugin ei ole paigaldatud antud konto jaoks.

Näidispäring

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

id=24304&changeType=NAME&changeType=INDEX&changeType=MONTH&changeType=YEAR&changeType=DESCRIPTION&changeType=KEYWORDS&changeType=EXPIRE_DATE&name=Test+kaust&index=TT123&month=4&year=2014&description=Test+kirjeldus.&keywords=test%2C+kaust&acc_key=abo5k66xjrjfohkjls71&sig=%2B1N%2BuwYa95l00hpYfhb3I28jpvw%3D

Näidisvastus

HTTP/1.1 200 OK
Date: Tue, 21 Jun 2011 14:33:46 GMT
Server: Apache
Content-Length: 17
Content-Type: application/json;charset=UTF-8

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