Muuda dokumenti

Veateate puhul ei tehta dokumendile ühtegi muudatust.

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

Päringu parameetrid

Parameeter Tüüp Kirjeldus
id Kohustuslik. Integer Muudetava dokumendi ID.
changeType Kohustuslik. String Muudetav atribuut, kehtivad väärtused on NAME, FILENAME, TITLE, AUTHOR, SUBJECT, KEYWORDS, PRODUCER, DESCRIPTION või EXPIRE_DATE.

Antud parameetrit võib kasutada päringus mitu korda. Näiteks kui soovitakse korraga muuta dokumendi nimetust (name) ja autorit (author) siis tuleks päringus saata changeType=NAME&changeType=AUTHOR&name=test&author=tester.
name
Vabatahtlik. String.
Dokumendi nimi ilma faililaiendita. Tähemärke ei tohi olla rohkem kui 255. Nimetus ei tohi sisaldada järgnevaid tähemärke: '/ \ : * ? < > " | '.
filename Vabatahtlik. String Failinimi koos olemasoleva laiendusega, st. üleslaadimisel antud dokumendi failinime laiendit ei saa muuta (see peab samaks jääma). Tähemärke ei tohi olla rohkem kui 255. Failinimi ei tohi sisaldada järgnevaid tähemärke: '/ \ : * ? < > " | '.
expireDate Vabatahtlik. Date Dokumendi aegumiskuupäev. Dokumendi kehtivuse aegumisel antakse ettevõttele sellest teada. Aegumiskuupäeva eemaldamiseks ei tohi seda parameetrit päringus esineda, näiteks changeType=EXPIRE_DATE.
title Vabatahtlik. String Metaandmete pealkirja väli. Tähemärke ei tohi olla rohkem kui 150.
author Vabatahtlik. String Metaandmete autori väli. Tähemärke ei tohi olla rohkem kui 150.
subject Vabatahtlik. String Metaandmete subjekti väli. Tähemärke ei tohi olla rohkem kui 150.
keywords Vabatahtlik. String Metaandmete märksõnade väli. Tähemärke ei tohi olla rohkem kui 255.
producer Vabatahtlik. String Metaandmete tootja väli. Tähemärke ei tohi olla rohkem kui 255.
description Vabatahtlik. String Metaandmete kirjelduse väli. Tähemärke ei tohi olla rohkem kui 250.

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_DOC_ID Parameeter id on vigane.
DOC_NOT_EXIST Parameetrile id vastavat dokumenti ei leitud.
INVALID_CHANGE_TYPE Parameetrile changeType ei ole omistatud ühtegi väärtust.
DOCUMENT_NAME_TAKEN Parameetriga name dokument on juba olemas muudetava dokumendi kaustas.
INVALID_METADATA_TITLE
Parameeter title ületab määratletud tähemärkide arvu.
INVALID_METADATA_KEYWORD
Parameeter keywords ületab määratletud tähemärkide arvu.
INVALID_METADATA_PRODUCER
Parameeter producer ületab määratletud tähemärkide arvu.
INVALID_METADATA_SUBJECT
Parameeter subject ületab määratletud tähemärkide arvu.
INVALID_METADATA_AUTHOR
Parameeter author ületab määratletud tähemärkide arvu.
INVALID_METADATA_DESCRIPTION
Parameeter description ületab määratletud tähemärkide arvu.
INVALID_EXPIRE_DATE
Parameeter expireDate on vigane.
PLUGIN_REMINDER_NOT_INSTALLED
Säilitustähtaja meeldetuletuse plugin ei ole paigaldatud antud konto jaoks.
INVALID_FILENAME
Parameeter filename puudub, ületab määratletud tähemärkide arvu, koosneb keelatud tähemärkidest või ei lõppe dokumendil olemasoleva failinime laiendiga (näiteks .doc).
INVALID_DOCUMENT_NAME Parameeter name puudub, ületab määratletud tähemärkide arvu või koosneb keelatud tähemärkidest.

Näidispäring

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

id=37933&changeType=NAME&changeType=FILENAME&changeType=TITLE&changeType=AUTHOR&changeType=SUBJECT&changeType=KEYWORDS&changeType=PRODUCER&changeType=DESCRIPTION&changeType=EXPIRE_DATE&name=hello+world&filename=hello_world.pdf&title=Test+title&author=Tester&subject=Test+subject&keywords=test%2C+hello%2C+world&producer=Test+producer&description=Test+description&acc_key=abo5k66xjrjfohkjls71&sig=Ri5WZtCD6WN%2FviZz1fxdrVUKuzU%3D

Näidisvastus

HTTP/1.1 200 OK
Date: Mon, 01 Jan 2011 09:58:41 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.