Dokumentide loetelu Digidocis

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

Päringu parameetrid

Parameeter Tüüp Kirjeldus
digidocId Kohustuslik. Integer. Digidoci ID mille dokumentide loetelu soovitakse. Sellel dokumendil peab atribuudi status väärtus olema CONVERTED.
sortBy Vabatahtlik. String. Dokumentide järjestamise kriteerium. Vaikimisi on parameetrile omistatud väärtus UPLOADED_DATE. Kehtivad väärtused on NAME, PAGES, CREATED_DATE ja UPLOADED_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 100.

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_DIGIDOC_ID Parameeter digidocId on vigane.
DOC_NOT_EXIST Parameetriga digidocId määratud dokumenti 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/digidoc/list.html HTTP/1.1
Content-Length: 152
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Host: api.arhivaar.ee
User-Agent: Test Client

digidocId=36342&sortBy=CREATED_DATE&sortDesc=false&paginationIndex=0&paginationSize=10&acc_key=abo5k66xjrjfohkjls71&sig=GNkii%2BqcOiDDjzSuwJxGKV1POms%3D

Näidisvastus

HTTP/1.1 200 OK
Date: Wed, 29 Jun 2011 12:32:51 GMT
Server: Apache
Content-Length: 769
Content-Type: application/json;charset=UTF-8

{
    "response":"OK", 
    "paginationSize":10,
    "paginationPages":1,
    "documents": [
        {
            "id":36343,
            "folderId":19565,
            "digidocId":36342,
            "digidoc":false,
            "documentName":"a",
            "filename":"a.pdf",
            "createdDate":1008108000000,
            "uploadedDate":1309350719172,
            "pages":10,
            "filesize":36094
        },
        {
            "id":36344,
            "folderId":19565,
            "digidocId":36342,
            "digidoc":false,
            "documentName":"b",
            "filename":"b.pdf",
            "createdDate":1143666000000,
            "uploadedDate":1309350719196,
            "pages":16,
            "filesize":60782
        }
    ]
}
 
Eesti Arhivaar OÜ © 2011. Kõik õigused on kaitstud. Tegevusluba nr. 000110.