Loo kaust

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

Päringu parameetrid

Parameeter Tüüp Kirjeldus
parentFolderId
Vabatahtlik. Integer.
Vanemkausta ID mille alamkaustaks saab uus loodav kaust. Vaikimisi on vanemkaustaks juurkaust.
path Vabatahtlik. String Vanemkausta teekond mille alamkaustaks saab uus loodav kaust, näiteks /Arved.
name
Kohustuslik. String. Uue kausta nimi. Tähemärke ei tohi olla rohkem kui 200. Nimetus ei tohi sisaldada järgmisi tähemärke: '/ \ : * ? < > " |'.
expireDate
Vabatahtlik. Date.
Kausta aegumiskuupäev. Kausta kehtivuse aegumisel antakse sellest ettevõttele teada.

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.
folder
FolderDetail
Loodud kaust.

Veakoodid

Nimetus Kirjeldus
INVALID_FOLDER_ID
Parameeter parentFolderId on vigane.
INVALID_FOLDER_PATH
Parameeter path on vigane.
FOLDER_NOT_EXISTS
Parameetriga parentFolderId või path määratud kaust ei eksisteeri.
INVALID_FOLDER_NAME_LENGTH
Parameeter name ületab määratletud tähemärkide arvu.
INVALID_FOLDER_NAME
Parameeter name puudub või koosneb keelatud tähemärkidest.
FOLDER_EXISTS
Parameetriga name kaust on juba olemas.
INVALID_EXPIRE_DATE
Parameeter expireDate on vigane.
PLUGIN_REMINDER_NOT_INSTALLED
Säilitustähtaja meeldetuletuse plugin ei ole paigaldatud antud konto jaoks.

Näidispäring

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

name=Test+folder&acc_key=abo5k66xjrjfohkjls71&sig=r%2BrZzV9abBJXs4lSevbo0vWcSf4%3D

Näidisvastus

HTTP/1.1 200 OK
Date: Mon, 01 Jan 2011 10:29:27 GMT
Server: Apache
Content-Length: 179
Content-Type: application/json;charset=UTF-8

{
    "folder":{
        "id":27086,
        "parentId":19565,
        "name":"Test folder",
        "createdDate":1312194567450,
        "root":false
    },
    "response":"OK"
}
 
Eesti Arhivaar OÜ © 2011. Kõik õigused on kaitstud. Tegevusluba nr. 000110.