Dokumendi üleslaadimine

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

Päringu parameetrid

Parameetrid mis algavad sõnaga metadata* asendavad metaandmed mis muidu võetakse dokumendist.

Parameetrid saadetakse multipart/form-data kujul. See tähendab, et igal multipart lõigul peab olema name atribuut.

Viimases lõigus saadetakse faili sisu. Sellel lõigul ei pea olema name atribuuti, kuid peab olema filename atribuut.

Parameeter Tüüp Kirjeldus
folderId Vabatahtlik. Integer Kausta ID millesse antud fail üleslaaditakse. Puuduva väärtuse puhul on selleks juurkaust.
path Vabatahtlik. String. Kausta teekond millesse antud fail üleslaaditakse. Näiteks /test.
filename Kohustuslik. String Failinimi koos laiendusega. Tähemärke ei tohi olla rohkem kui 255. Failinimi ei tohi sisaldada järgnevaid tähemärke: '/ \ : * ? < > " | '.
batch Vabatahtlik. String Unikaalne ID mis identifitseerib hulk dokumente, laetavaid ühes partiis. Tähemärke ei tohi olla rohkem kui 36.
expireDate Vabatahtlik. Date Dokumendi aegumiskuupäev. Dokumendi kehtivuse aegumisel antakse ettevõttele sellest teada.
metadataTitle Vabatahtlik. String Metaandmete pealkirja väli. Tähemärke ei tohi olla rohkem kui 150.
metadataAuthor Vabatahtlik. String Metaandmete autori väli. Tähemärke ei tohi olla rohkem kui 150.
metadataSubject Vabatahtlik. String Metaandmete subjekti väli. Tähemärke ei tohi olla rohkem kui 150.
metadataKeywords Vabatahtlik. String Metaandmete märksõnade väli. Tähemärke ei tohi olla rohkem kui 255.
metadataProducer Vabatahtlik. String Metaandmete tootja väli. Tähemärke ei tohi olla rohkem kui 255.
metadataDescription Vabatahtlik. String Metaandmete kirjelduse väli. Tähemärke ei tohi olla rohkem kui 250.

Päringu keha

Fail binaarsel kujul

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.
document DocumentDetail.
Loodud dokument.

Veakoodid

Nimetus Kirjeldus
INVALID_FOLDER_ID
Parameeter folderId on vigane.
INVALID_FOLDER_PATH Parameeter path on vigane.
INVALID_BATCH
Parameeter batch ületab määratletud tähemärkide arvu.
QUOTA_LIMIT
Ettevõttele eraldatud lehekülgede arv (A4) on otsa saanud.
FOLDER_NOT_EXISTS
Parameetriga folderId või path määratud kaust ei eksisteeri.
INVALID_METADATA_TITLE
Parameeter metadataTitle ületab määratletud tähemärkide arvu.
INVALID_METADATA_KEYWORD
Parameeter metadataKeywords ületab määratletud tähemärkide arvu.
INVALID_METADATA_PRODUCER
Parameeter metadataProducer ületab määratletud tähemärkide arvu.
INVALID_METADATA_SUBJECT
Parameeter metadataSubject ületab määratletud tähemärkide arvu.
INVALID_METADATA_AUTHOR
Parameeter metadataAuthor ületab määratletud tähemärkide arvu.
INVALID_METADATA_DESCRIPTION
Parameeter metadataDescription ü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 või koosneb keelatud tähemärkidest.
NO_FILE_DATA
Üleslaetavat faili ei leitud päringus.
FILE_SIZE_TOO_BIG
Üleslaaditud faili suurus on suurem kui lubatud sellise dokumendi jaoks.

Näidispäring

POST /api/v0_4/document/upload.html HTTP/1.1
Content-Type: multipart/form-data; boundary=Xo_7f28DL488svELlBFwJr5SQ7Bmf_fdKhZ
Host: api.arhivaar.ee
User-Agent: Test Client

--Xo_7f28DL488svELlBFwJr5SQ7Bmf_fdKhZ
Content-Disposition: form-data; name="filename"
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

hello.txt
--Xo_7f28DL488svELlBFwJr5SQ7Bmf_fdKhZ
Content-Disposition: form-data; name="batch"
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

550E8400-E29B-11D4-A716-446655440000
--Xo_7f28DL488svELlBFwJr5SQ7Bmf_fdKhZ
Content-Disposition: form-data; name="metadataProducer"
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Sample Producer
--Xo_7f28DL488svELlBFwJr5SQ7Bmf_fdKhZ
Content-Disposition: form-data; name="acc_key"
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

abo5k66xjrjfohkjls71
--Xo_7f28DL488svELlBFwJr5SQ7Bmf_fdKhZ
Content-Disposition: form-data; name="sig"
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

FcmDHCxcAWkrW+tNRLY37NJ0iGM=
--Xo_7f28DL488svELlBFwJr5SQ7Bmf_fdKhZ
Content-Disposition: form-data; name="file"; filename="hello.txt"
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary

Hello, World!

--Xo_7f28DL488svELlBFwJr5SQ7Bmf_fdKhZ--

Näidisvastus

HTTP/1.1 200 OK
Date: Mon, 01 Jan 2011 09:02:24 GMT
Server: Apache
Content-Length: 326
Content-Type: application/json;charset=UTF-8

{
    "document":{
        "id":37940,
        "folderId":19565,
        "digidoc":false,
        "documentName":"hello",
        "filename":"hello.txt",
        "createdDate":1312189345063,
        "uploadedDate":1312189345063,
        "pages":0,
        "filesize":0,
        "status":"UPLOADED"
    },
    "response":"OK"
}
 
Eesti Arhivaar OÜ © 2011. Kõik õigused on kaitstud. Tegevusluba nr. 000110.