Uuendatud 31. juuli 2025
REST API päringud ja vastused JSON formaadis
Käesoleval lehel kirjeldatakse Standard Books API kasutamist päringute tegemiseks ja vastuste saamiseks JSON formaadis. Enne jätkamist lugege API seadistamise, GET päringute ja POST päringute tegemisest.
Kui soovite, et päringud ja/või vastused oleksid JSON-vormingus, peate lisama sellekohase juhise päringu päisesse. Näiteks, JSON-vormingus vastust nõudva GET-päringu päises peab olema:
- curl -X GET -H “Accept: application/json” ‘http://hostname.domain.top:web port/api/1/IVVc’
GET-päringuid saab täpsustada SIIN kirjeldatud viisil. Näiteks:
- curl -X GET -H “Accept: application/json” ‘http://hostname.domain.top:web port/api/1/IVVc?sort=CustCode’
POST ja PATCH päringud, mille päring on JSON vormingus, peaksid sisaldama päises:
-H “Content-Type: application/json“
Selles PATCH-päringu näites on päring JSON-vormingus ja nõutakse JSON-vastust:
- curl -X PATCH \
- -H “Accept: application/json” \
- -H “Content-Type: application/json” \
- -d ‘{“data”:{“IVVc”:[{“Addr1″:”New Address Line 1″,”Addr2″:”New Address Line 2”}]}}’ \
- ‘http://hostname.domain.top:web port/api/1/IVVc/10000022’
See muudab arve 10000022 arve aadressi kaks esimest rida „Uus aadressirida 1” ja „Uus aadressirida 2” (lahter Addr1 ja Addr2 IVVc-s).
Ainult POST-iga saate sama päringuga koostada mitu kaarti:
- curl -X POST \
- -H “Accept: application/json” \
- -H “Content-Type: application/json” \
- -d ‘{“data”:{“ObjVc”:[{“Code”:”TEST1″,”Comment”:”Test 1″,”OTCode”:”PERS”},{“Code”:”TEST2″,”Comment”:”Test 2″,”OTCode”:”PERS”}]}}’ \
- ‘http://hostname.domain.top:web port/api/1/ObjVc?fields=Code,Comment,OTCode’
See koostab kaks objekti TEST1 ja TEST2, mis kuuluvad objektitüübi „PERS” alla, ning vastuses kuvatakse ainult nende uute objektide kood, kommentaar ja objektitüüp.
Järgmine näide koostab kahe reaga Pakkumise. Pange tähele, et reade numereerimine algab 0-st:
- curl -X POST \
- -H “Accept: application/json” \
- -H “Content-Type: application/json” \
- -d ‘{“data”:{“QTVc”:[{“CustCode”:”005″,”PayDeal”:”30″,”Addr0″:”Agent – Polani Travel”,”QTDate”:”2022-04-27″,”QuoteClass”:”V”,”CurncyCode”:”GBP”,”ToRateB1″:””,”FrRate”:””, “ToRateB2″:””,”BaseRate1″:”0.8952″,”BaseRate2″:”1″,”Sum1″:”42.00″,”Sum3″:”8.40″,”Sum4″:”50.40″, “ExportFlag”:”0″,”rows”:[{“@rownumber”:”0″,”ArtCode”:”10101″,”Spec”:”Transistor Radio”,”SalesAcc”:”100″,”VATCode”:”1″,”Objects”:”AUDIO”,”Price”:”25.00″,”Quant”:”1.000″,”Sum”:”25.00″},{“@rownumber”:”1″,”ArtCode”:”10104″,”Spec”:”Loudspeakers”,”SalesAcc”:”100″,”VATCode”:”1″, “Objects”:”AUDIO”,”Price”:”17.00″,”Quant”:”1.000″,”Sum”:”17.00″}]}]}}’ \
- ‘http://hostname.domain.top:web port/api/1/QTVc’
NB! Pange tähele, et kui kasutate POST-päringus set_field ja set_row_fields), viiakse läbi kõik aknatoimingud (window action) ja kaarditoimingud (record action). Kui aga POST-päringu saadate JSON-vormingus, viiakse läbi ainult kaardi toimingud. See tähendab näiteks, et kui saadate kliendinumbri uuele müügiarvele, ei kanta müügiarvele sellist teavet nagu kliendi nimi, tasumistingimus ja hinnakiri, seega peate selle teabe lisama päringusse. Salvestamisel tehakse kaardi valideerimiskontroll, seega kaarti ei salvestata, kui esineb probleem, ning JSON-vastusesse lisatakse vastav veateade.