Scheme de date: Modele comune

codeȘir de caractereObligatoriu

Cod stabil, destinat prelucrării automate.

Restricții

enum

["request.malformed", "authentication.required", "authentication.invalid_credentials", "authorization.scope_denied", "authorization.ip_not_allowed", "authorization.client_ip_unverified", "entitlements.api_disabled", "entitlements.operation_disabled", "entitlements.limit_exceeded", "entitlements.resource_blocked", "resource.not_found", "request.method_not_allowed", "resource.version_conflict", "resource.state_conflict", "resource.in_use", "resource.already_exists", "idempotency.key_reused", "request.too_large", "request.unsupported_media_type", "request.validation_failed", "rate_limit.exceeded", "capacity.queue_full", "capacity.wait_timeout", "internal.error", "gateway.bad_response", "service.unavailable", "gateway.timeout"]

Exemplu: "authentication.invalid_credentials"

fieldsTablou <FieldError > | nullOpțional

Erorile de validare pentru câmpurile individuale.

Exemplu: null

messageȘir de caractereObligatoriu

Explicație destinată utilizatorilor; folosiți codul de eroare în logica programului.

Exemplu: "The credentials are invalid."

Câmpuri suplimentare: Nu

dataMutationData Obligatoriu

Exemplu de răspuns · MutationData.

Exemplu: {"deleted":false,"id":"example","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatoriu

Metadatele răspunsului.

Exemplu: {"request_id":"example"}

Câmpuri suplimentare: Nu

localeȘir de caractereObligatoriu

Limba selectată pentru această cerere.

Exemplu: "en"

market_codeȘir de caractereObligatoriu

Codul pieței returnat de endpointul de context.

Exemplu: "PL"

market_idȘir de caractereObligatoriu

Identificatorul pieței returnat de endpointul de context.

Exemplu: "example"

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100

Exemplu: "example"

Câmpuri suplimentare: Nu

localeȘir de caractereObligatoriu

Limba selectată pentru această cerere.

Exemplu: "en"

market_codeȘir de caractereObligatoriu

Codul pieței returnat de endpointul de context.

Exemplu: "PL"

market_idȘir de caractereObligatoriu

Identificatorul pieței returnat de endpointul de context.

Exemplu: "example"

paginationPagination Obligatoriu

Metadatele paginării prin cursor.

Exemplu: {"has_more":false,"limit":20,"next_cursor":null}

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100

Exemplu: "example"

Câmpuri suplimentare: Nu

errorApiError Obligatoriu

Informații structurate despre eroare.

Exemplu: {"code":"authentication.invalid_credentials","fields":null,"message":"The credentials are invalid."}

metaRequestMeta Obligatoriu

Metadatele răspunsului.

Exemplu: {"request_id":"example-request"}

Câmpuri suplimentare: Nu

codeȘir de caractereObligatoriu

Cod stabil, destinat prelucrării automate.

Restricții

enum

["required", "invalid_type", "invalid_value", "out_of_range", "unknown_field", "invalid_format", "invalid_cursor", "unsupported_value"]

fieldȘir de caractereObligatoriu

Câmpul asociat unei erori de validare.

minLength: 1maxLength: 128

locationȘir de caractereObligatoriu

Informații despre locație.

Restricții

enum

["path", "query", "header", "body"]

Câmpuri suplimentare: Nu

amountȘir de caractereObligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

Exemplu: "0.00"

currencyȘir de caractereObligatoriu

Codul monedei în care este exprimată suma.

Restricții

pattern

"^[A-Z]{3}$"

Exemplu: "PLN"

minor_unitsNumăr întregObligatoriu

Numărul de zecimale folosite de monedă.

minimum: 0maximum: 4

Exemplu: 2

Câmpuri suplimentare: Nu

deletedValoare booleanăObligatoriu

Indică dacă ștergerea a fost aplicată.

Exemplu: false

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (MutationData).

Exemplu: "example"

versionNumăr întreg | nullObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

Câmpuri suplimentare: Nu

paginationPagination Obligatoriu

Metadatele paginării prin cursor.

Exemplu: {"has_more":false,"limit":20,"next_cursor":null}

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100

Exemplu: "example"

Câmpuri suplimentare: Nu

has_moreValoare booleanăObligatoriu

Indică dacă există o pagină următoare.

Exemplu: false

limitNumăr întregObligatoriu

Numărul maxim de înregistrări pe această pagină.

minimum: 1maximum: 100

Exemplu: 20

next_cursorȘir de caractere | nullObligatoriu

Valoare de continuare pentru pagina următoare sau null.

Exemplu: null

Câmpuri suplimentare: Nu

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100

Exemplu: "example"

Câmpuri suplimentare: Nu