Izmantotā SERP versija ir 8.5 2019-06-05 build 85310221, testēts, izmantojot Postman.
...
Atbildes uz visiem pieprasījumiem varam formatēt, izmantojot GET papildu parametrus, kurus savā starpā var brīvi kombinēt:
- sort - nosaka secību;
- range - var izvēlēties kādu ierakstu diapozonu pēc izvēlētā sort parametra skatīt;
- fields - nosaka laukus, kurus iekļaut atbildē;
- filter - atgriež ierakstus, kuri atbilst filtram;
- offset un limit - var sadalīt API atbildi;
- updates_after - atgriež ierakstus, kas ir mainīti pēc dotā sekvences skaitļa;
- deletes_after - atgriež ierakstus, kas ir dzēsti pēc dotā sekvences skaitļa.
...
offset un limit
Ja pēc pieprasījuma sagaida lielu atbildisagaidāma liela atbilde, to ir iespējams sadalīt.
...
Piem., http://localhost:8085/api/1/IVVc?offset=5&limit=5 izlaidīs pirmos 5 un ietvers otros 5 ierakstus no reģistra.
Var kombinēt ar sort.
updates_after
in progress
deletes_after
...
in progressupdates_after
Atgriezīs tikai tos ierakstus, kas ir mainīti pēc padotā sekvences numura.
Piem., http://localhost:8085/api/1/IVVc?updates_after=16201
...
deletes_after
Atgriezīs to ierakstus, kas ir dzēsti pēc padotā sekvences numura. Par sekvences numuriem zemāk.
Piem., http://localhost:8085/api/1/IVVc?updates_after=16213
...
| Note |
|---|
Lai dabūtu ierakstu pēc SerNr vai jebkāda cita reģistra MainKey lauka, jāizmanto range, vienīgi šajā gadījumā pie sort jānorāda lauka nosaukums: sort=SerNr&range=23001 |
...
- set_field._______ - norāda lauka vērtību, aiz punkta norāda lauka nosaukumu;
- set_row_field.#._______ - norāda rindas lauka vērtību, aiz punkta norāda rindas numuru (sāk skaitīt no 0), tālāk lauka nosaukumu.
POST
Ar POST metodi var izveidot jaunus ierakstus.
...
Piem., http://localhost:8085/api/1/IVVc/99999?set_field.CustCode=20202&set_row_field.0.Quant=9 - rēķinam Nr. 99999 nomainīs klientu uz 20202 un pirmās rindas artikulu skaitu uz 9.
Sekvences numuri
Katrs REST API pieprasījums iekš <data> taga atgriež numuru sequence, kuri pieaug kaut kā.
<data register="ORVc" sequence="16197" sort="SerNr" key="SerNr" systemversion="8.5.31.221">
JTE TODOs:
- updates_after and deletes_after
- POST komandas
- kā POST un PATCH spēj tikt tiekt galā ar diakritiskajām zīmēm (NETIEK) vai arī saprast, kādu charsetu Hansa izmanto, vai arī saprast, kā pareizi pieprasījumā norādīt to
- PATCH komandas - interesanti būtu paskatīties, ko API dara ar ierakstiem, kuros jau ir diakritiskās zīmes
- kā PATCH tiek galā ar custom un blokveida reģistriem
- saprast, kā šo var darīt bez Postman