https://api.arhivaar.ee/api/v0_4/search.html
| Parameeter | Tüüp | Kirjeldus |
query
| Vabatahtlik. String.
| Otsingu põhikriteerium.
|
queryContent
| Vabatahtlik. Boolean.
| Tõese väärtuse puhul otsitakse lisaks nimele ja kirjeldusele ka dokumentide sisust põhikriteeriumile vastavaid dokumente/kaustu. Vaikimisi on selle parameetri väärtuseks true.
|
docFilename
| Vabatahtlik. String.
| Dokumendi failinimi. |
docTitle
| Vabatahtlik. String.
| Dokumendi metaandmete pealkirja väli. |
docAuthor
| Vabatahtlik. String.
| Dokumendi metaandmete autori väli. |
docSubject
| Vabatahtlik. String.
| Dokumendi metaandmete subjekti väli. |
docKeywords
| Vabatahtlik. String.
| Dokumendi metaandmete märksõnade väli. |
docHasExpireDate
| Vabatahtlik. Boolean.
| Otsi dokumente millel on aegumiskuupäev.
|
folderName
| Vabatahtlik. String.
| Kausta nimetus. |
folderIndex
| Vabatahtlik. String.
| Kausta tähis. |
folderDescription
| Vabatahtlik. String.
| Kausta kirjeldus. |
folderKeywords
| Vabatahtlik. String.
| Kausta märksõnad. |
folderHasExpireDate
| Vabatahtlik. Boolean.
| Otsi kaustu millel on aegumiskuupäev.
|
createdDateStart
| Vabatahtlik. Date.
| Loomiskuupäeva lõigu alguskuupäev (kaasa arvatud).
|
createdDateEnd
| Vabatahtlik. Date.
| Loomiskuupäeva lõigu lõppkuupäev (kaasa arvatud).
|
modifiedDateStart
| Vabatahtlik. Date.
| Muutmise kuupäeva lõigu alguskuupäev (kaasa arvatud).
|
modifiedDateEnd
| Vabatahtlik. Date.
| Muutmise kuupäeva lõigu lõppkuupäev (kaasa arvatud).
|
filesizeStart
| Vabatahtlik. Integer.
| Dokumendi faili suuruse lõigu algus baitide arv (kaasa arvatud).
|
filesizeEnd
| Vabatahtlik. Integer.
| Dokumendi faili suuruse lõigu lõpp baitide arv (kaasa arvatud).
|
pagesStart
| Vabatahtlik. Integer.
| Dokumendi lehekülgede arvu otsimise lõigu algus väärtus (kaasa arvatud).
|
pagesEnd
| Vabatahtlik. Integer.
| Dokumendi lehekülgede arvu otsimise lõigu lõppväärtus (kaasa arvatud).
|
sortBy
| Vabatahtlik. String.
| Dokumentide/kaustade järjestamise kriteerium. Vaikimisi on parameetrile omistatud väärtus NAME. Kehtivad väärtused on NAME, PAGES, CREATED_DATE, UPLOADED_DATE või 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/kaustade arv lehekülje kohta, suurim lubatud väärtus on 10000.
|
| 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/kaustade arv lehekülje kohta. |
paginationPages
| Integer.
| Kogu lehekülgede arv. Arvutatakse kogu dokumentide/kaustade arvu ja parameetri paginationSize alusel. |
documents
| DocumentDetail[].
| Dokumentide massiiv. |
| folders | FolderDetail[] | Kaustade massiiv. |
| Nimetus | Kirjeldus |
| INVALID_QUERY_CONTENT | Parameeter queryContent on vigane. |
INVALID_DOC_HAS_EXPIRE_DATE
| Parameeter docHasExpireDate on vigane. |
INVALID_FOLDER_HAS_EXPIRE_DATE
| Paremeeter folderHasExpireDate on vigane. |
INVALID_CREATED_DATE_START
| Parameeter createdDateStart on vigane. |
INVALID_CREATED_DATE_END
| Parameeter createdDateEnd on vigane. |
INVALID_MODIFIED_DATE_START
| Parameeter modifiedDateStart on vigane. |
INVALID_MODIFIED_DATE_END
| Parameeter modifiedDateEnd on vigane. |
INVALID_FILESIZE_START
| Parameeter filesizeStart on vigane. |
INVALID_FILESIZE_END
| Parameeter filesizeEnd on vigane. |
INVALID_PAGES_START
| Parameeter pagesStart on vigane. |
INVALID_PAGES_END
| Parameeter pagesEnd on vigane. |
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_BY
| Parameetrile sortBy on omistatud vigane väärtus. |
INVALID_SORT_DESC
| Parameeter sortDesc on vigane. |
POST /api/v0_4/search.html HTTP/1.1
Content-Length: 146
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Host: api.arhivaar.ee
User-Agent: Test Client
query=test+dokument&folderKeywords=test&createdDateStart=725839200000&pagesStart=1&acc_key=abo5k66xjrjfohkjls71&sig=U2mVq0kQbxYGZ3MlLzddNhXm4F0%3D
HTTP/1.1 200 OK
Date: Mon, 01 Jan 2011 11:09:01 GMT
Server: Apache
Content-Length: 836
Content-Type: application/json;charset=UTF-8
{
"paginationSize":10000,
"paginationPages":1,
"documents":[
{
"id":37912,
"folderId":27083,
"digidoc":false,
"documentName":"test dokument",
"filename":"test dokument.pdf",
"createdDate":1177621200000,
"uploadedDate":1311936435188,
"pages":14,
"filesize":70461,
"status":"CONVERTED"
}
],
"folders":[
{
"id":27084,
"parentId":27083,
"name":"Test kaust A",
"createdDate":1312193819036,
"root":false
},
{
"id":27085,
"parentId":27083,
"name":"Test kaust B",
"createdDate":1312193828747,
"root":false
}
],
"response":"OK"
}
