Objektitüübid
Võimalikud päringu vastuses kasutatavate objektide tüübid.
Error
| Väli | Tüüp | Kirjeldus |
|---|---|---|
| name | String | Veateate nimetus. |
| description | String | Veateate laiendatud kirjeldus. |
DocumentDetail
| Väli | Tüüp | Kirjeldus |
|---|---|---|
| id | Integer | Dokumendi ID. |
| folderId | Integer | Kausta ID millega antud dokument on seotud. |
| digidocId | Integer | See on vanema DigiDoc dokumendi ID juhul kui see dokument on alamdokument. |
| digidoc | Boolean | Tõene väärtus kui antud dokument on DigiDoc. |
| documentName | String | Dokumendi nimi ilma faililaiendita. |
| filename | String | Dokumendi failinimi. |
| createdDate | Date | Kuupäev millal dokument oli loodud. |
| uploadedDate | Date | Kuupäev millal dokument oli üleslaetud. |
| pages | Integer | Lehekülgede arv (ühik on A4). |
| filesize | Integer | Dokumendi faili suurus baitides. |
| status | String | Dokumendi olek. Kehtivad väärtused on: UPLOADED - Dokumenti konverteeritakse või hakatakse konverteerima, sellel ajal pole kõik dokumendi väljad täidetud andmetega ja dokumenti ei saa allalaadida. CONVERTED - Dokument on edukalt konverteeritud. Kõik väljad on täidetud vastavate andmetega ja dokumenti saab allalaadida. |
Document
Lisaks alltoodud väljadele sisaldab kõiki DocumentDetail tüübi välju.
| Väli | Tüüp | Kirjeldus |
|---|---|---|
| title | String. | Metaandmete pealkirja väli. |
| author | String. | Metaandmete autori väli. |
| subject | String. | Metaandmete subjekti väli. |
| keywords | String. | Metaandmete märksõnade väli. |
| producer | String. | Metaandmete tootja väli. |
| description | String. | Metaandmete kirjelduse väli. |
| modifiedDate | Date. | Kuupäev millal antud dokumenti viimati muudeti. |
| expireDate | Date. | Dokumendi aegumiskuupäev. Dokumendi kehtivuse aegumisel antakse ettevõttele sellest teada. |
| viewedTally | Integer. | Mitu korda antud dokumenti on vaadatud arhiivis. |
| downloadedTally | Integer. | Mitu korda antud dokumenti on allalaetud. |
FolderDetail
| Väli | Tüüp | Kirjeldus |
|---|---|---|
| id | Integer | Kausta ID. |
| parentId | Integer | Vanemkataloogi ID milles antud kaust asetseb. Juurkausta puhul pole väärtust. |
| name | String | Kausta nimi. |
| createdDate | Date | Kuupäev millal kaust oli loodud. |
| root | Boolean | Tõese väärtuse puhul on tegemist juurkaustaga. |
Folder
Lisaks alltoodud väljadele sisaldab kõiki FolderDetail tüübi välju.
| Väli | Tüüp | Kirjeldus |
|---|---|---|
| index | String | Metaandmete tähise väli. Maksimaalne pikkus on 150 tähemärki. |
| month | Integer | Metaandmete kuu väli. Võimalik väärtus on 1-12 (kaasa arvatud). |
| year | Integer | Metaandmete aasta väli. |
| description | String | Metaandmete kirjelduse väli. Maksimaalne pikkus on 250 tähemärki. |
| keywords | String | Metaandmete märksõnade väli. Maksimaalne pikkus on 250 tähemärki. |
| expireDate | Date | Kausta aegumiskuupäev. Kausta kehtivuse aegumisel antakse sellest ettevõttele teada. |