Dokumentide loetelu kaustas

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

Päringu parameetrid

Parameeter Tüüp Kirjeldus
folderId
Vabatahtlik. Integer.
Kausta ID mille dokumentide loetelu soovitakse. Puuduva väärtuse puhul on selleks juurkaust.
sortBy
Vabatahtlik. String.
Dokumentide järjestamise kriteerium. Vaikimisi on parameetrile omistatud väärtus UPLOADED_DATE. Kehtivad väärtused on NAME, PAGES, CREATED_DATE, UPLOADED_DATE ja EXPIRE_DATE.
sortDesc
Vabatahtlik. Boolean.
Järjesta kahanevas järjekorras. Vaikimisi on see väärtus false.
paginationIndex
Vabatahtlik. Integer.
Aktiivne lehekülg, vaikimisi on see väärtus 0.
paginationSize
Vabatahtlik. Integer.
Dokumentide arv lehekülje kohta, suurim lubatud väärtus on 10000.

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.
paginationSize
Integer.
Dokumentide arv lehekülje kohta.
paginationPages
Integer.
Kogu lehekülgede arv. Arvutatakse kogu dokumentide arvu ja parameetri paginationSize alusel.
documents
DocumentDetail[].
Dokumentide massiiv.

Veakoodid

Nimetus Kirjeldus
INVALID_FOLDER_ID
Parameeter folderId on vigane.
FOLDER_NOT_EXISTS
Parameetriga folderId määratud kaust ei eksisteeri.
INVALID_SORT_BY
Parameetrile sortBy on omistatud vigane väärtus.
INVALID_PAGINATION_INDEX
Parameeter paginationIndex on vigane.
INVALID_PAGINATION_SIZE
Parameetrile paginationSize on omistatud vigane väärtus või see ületab määratletud piirväärtust.
INVALID_SORT_DESC
Parameeter sortDesc on vigane.

Näidispäring

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

folderId=27083&sortBy=CREATED_DATE&paginationIndex=0&paginationSize=10&acc_key=abo5k66xjrjfohkjls71&sig=wuAjcUwcRHugnV9aNTm%2B8rY4W%2FA%3D

Näidisvastus

HTTP/1.1 200 OK
Date: Mon, 01 Jan 2011 08:34:20 GMT
Server: Apache
Content-Length: 819
Content-Type: application/json;charset=UTF-8

{
    "paginationSize":10,
    "paginationPages":1,
    "documents": [
        {
            "id":37932,
            "folderId":27083,
            "digidoc":false,
            "documentName":"hello world",
            "filename":"hello_world.pdf",
            "createdDate":1133474400000,
            "uploadedDate":1311938290526,
            "pages":19,
            "filesize":875711,
            "status":"CONVERTED"
        },
        {
            "id":37912,
            "folderId":27083,
            "digidoc":false,
            "documentName":"test dokument",
            "filename":"test dokument.pdf",
            "createdDate":1177621200000,
            "uploadedDate":1311936435188,
            "pages":14,
            "filesize":70461,
            "status":"CONVERTED"
        }
    ],
    "response":"OK"
}
 
Eesti Arhivaar OÜ © 2011. Kõik õigused on kaitstud. Tegevusluba nr. 000110.