-
Notifications
You must be signed in to change notification settings - Fork 0
60 REST API paringud
PISTRIKu REST API pakub x-teel tarbitavaid teenuseid, mille kaudu saab PISTRIKusse lisada, pärida, muuta ja kustutada (nn CRUD toimingud) jäätmearuandlusega, sh -vedudega seonduvat:
- Jäätmeveo osapoolel lisada, vaadata, muuta ja kustutada siseriiklike ohtlike- ja tavajäätmete veo saatekirju
- Jäätmearuandekohuslasel lisada, vaadata, muuta ja kustutada jäätmekäitluskohas teostatud jäätmekäitlustoimingute andmeid
- Jäätmearuandekohuslastel pärida jäätmealastelt keskkonnalubadelt andmeid millistes jäätmekäitluskohtades milliseid jäätmeid on lubatud vastu võtta ja millistes kogustes ladustada ja käidelda ning millist taaskasutamis- ja kõrvaldamistoimingut teostada
PISTRIKu poolt pakutavad teenused on jaotatud loogilistesse gruppidesse:

| Kataloog | Kirjeldus |
|---|---|
| cls | PISTRIKus kasutatavad klassifikaatorid (nt jäätmenimistu, koguse määramise meetodid jne) |
| registry | PISTRIKus kasutatavad jäätmearuandlusobjektid (nt jäätmekäitluskohad, laevad, KOJV veopiirkonnad jne) |
| balance | Jäätmearuandes kajastatavad käitlustoimingute REST teenused |
| wastenote | Siseriiklike jäätmeveo saatekirjade REST teenused |
| system | PISTRIKu ärifunktsionaalsusega otseselt mitte seotud REST teenused (nt /status) |
Teenuste OpenAPI kirjelduste allalaadimisvõimalused on pikemalt lahti kirjutatud lehel: OpenAPI kirjeldus
PISTRIKu poolt pakutavate REST API üksikute teenuste detailsed kirjeldused koos näidispäringute ja -vastustega on loodud Postmani tarkvara baasil. Käesolevas WIKIs neid pole dubleerivalt kirjeldatud, et vältida muudatusi mitmes erinevas kohas.
PISTRIKu Postmani ressursid on avalikult kättesadavad 'workspace:' https://www.postman.com/pistrik/pistrik-public/
Lisaks on Postmani workspace lingitud käesoleva GitHubi repoga, seega on kõik Postmani ressursid (sh muudatused) nähtavad ka käesolevas GIT reposkemitgituser/pistrik-api-documentation repos
Siseriiklike saatekirjade ja käitlustoiminguteenuste loomise (CREATE) teenustes kasutatavate andmeväljade kohustuslikkuse maatriks ehk millised andmeväljad on kohustuslikud või vabatahtlikud on saadaval allalaadimiseks:
| Versioon | Fail | Muudatuse kirjeldus |
|---|---|---|
| v1.0 | PISTRIK_API_andmevaljad_v1_0.xlsx | Esimene versioon |