Aqbeż għall-kontenut
ShopentlyLearn

Talbiet u tweġibiet

Aqra flimkien l-istatus HTTP, id-data JSON b’tipi definiti u l-metadata tat-talba.

Talba

Content-Type: application/json
Ibgħat kitbiet JSON b’Content-Type: application/json.
data · meta
Tweġibiet ta’ suċċess fihom data u meta; tweġibiet ta’ kollezzjonijiet jiddeskrivu wkoll il-paġinazzjoni.
error.code · error.message
L-iżbalji fihom error.code, error.message u informazzjoni dwar l-oqsma fejn applikabbli.

Tipi ta’ data

  • Il-ħtieġa ta’ qasam u l-permess għal null huma indipendenti.
  • Qasam obbligatorju jista’ jkun null jekk l-iskema tippermetti dan.
  • Żomm il-valuri Boolean, in-numri sħaħ, is-strings u null ta’ JSON mingħajr konverżjoni sfurzata.
  • L-ammonti monetarji huma strings deċimali; tużax floating point binarju biex tikkalkula l-prezzijiet.

64-bit · expected_version

  • Xi verżjonijiet għall-kontroll tal-konkorrenza jużaw numri sħaħ ta’ 64 bit b’sinjal.
  • Klijent JavaScript irid jipproċessa JSON mingħajr telf għal valuri ’l fuq minn Number.MAX_SAFE_INTEGER u jibgħat ir-rappreżentazzjoni oriġinali tan-numru sħiħ.
  • Tqarrebx verżjoni u tibdilhiex fi string JSON.

Headers

Cache-ControlStringMhux obbligatorju

Politika tal-cache tat-tweġiba.

const: "no-store"
X-Correlation-IDStringMhux obbligatorju

Identifikatur biex issegwi din it-talba HTTP.

WWW-AuthenticateStringMhux obbligatorju

Skema ta’ awtentikazzjoni meħtieġa mis-server.

AllowStringMhux obbligatorju

Metodi HTTP appoġġati minn din ir-riżorsa.

Retry-AfterNumru sħiħMhux obbligatorju

Dewmien minimu qabel tentattiv ieħor, f’sekondi.

minimum: 0
LocationStringMhux obbligatorju

URL relattiv tar-riżorsa maħluqa.