https://api.arhivaar.ee/api/v0_4/folder/list.html
| Parameeter | Tüüp | Kirjeldus |
folderId
| Vabatahtlik. Integer.
| Vanemkataloogi ID mille alamkaustu soovitakse lehitseda. Vaikimisi on selleks juurkaust.
|
sortBy
| Vabatahtlik. String.
| Kaustade järjestamise kriteerium. Vaikimisi on parameetrile omistatud väärtus NAME. Kehtivad väärtused on NAME ja CREATED_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.
| Kaustade arv lehekülje kohta, suurim väärtus on 1000.
|
| 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.
| Kaustade arv lehekülje kohta.
|
paginationPages
| Integer.
| Kogu lehekülgede arv. Arvutatakse kogu kaustade arvu ja parameetri paginationSize alusel.
|
folders
| FolderDetail[].
| Alamkaustade massiiv. |
| 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.
|
POST /api/v0_4/folder/list.html HTTP/1.1
Content-Length: 141
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Host: api.arhivaar.ee
User-Agent: Test Client
folderId=27083&sortBy=NAME&sortDesc=false&paginationIndex=0&paginationSize=10&acc_key=abo5k66xjrjfohkjls71&sig=VErITNU79OwLBXpSoKGAfRyrBc0%3D
HTTP/1.1 200 OK
Date: Mon, 01 Jan 2011 10:18:41 GMT
Server: Apache
Content-Length: 447
Content-Type: application/json;charset=UTF-8
{
"paginationSize":10,
"paginationPages":1,
"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"
}
