Кодна листа по тип

GET

/api/integration/v1/codelists/{type}

Returns the active entries of one code list.

These are the very values used internally, read for the tenant’s UJP environment. A new entry appearing in a code list is not a breaking change.

Примерот важи само за demo околината.

Request

curl -i -X GET "https://sandbox.api.earhiva.mk/api/integration/v1/codelists/<type>" \
  -H "X-Api-Key: <ВАШИОТ КЛУЧ>" \
  -H "X-Software-Id: <ИМЕ И ВЕРЗИЈА НА ВАШАТА АПЛИКАЦИЈА>"

Секој повик носи X-Api-Key со клуч што го има опфатот IntegrationApi, и X-Software-Id со името и верзијата на твојот софтвер. Како се бара клуч стои во Автентикација.

Parameters

Сите параметри (2)

Parameter	In	Type	Presence	Description
type	path	string	always	One of the eleven supported code list types.
X-Software-Id	header	string	always	Identifier of the calling software, e.g. SSBFocus/4.2.1. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.

Error codes

EARH-1001 · EARH-1002 · EARH-1003 · EARH-1004 · EARH-1005 · EARH-1006 · EARH-2021

Целосниот список шифри, со што значат и што да се направи, е во Каталог на грешки.

Responses

200

The requested type and its active entries.

{
  "type": "",
  "items": [
    {
      "code": "",
      "name": ""
    }
  ]
}

Сите полиња во телото (2)

Field	Type	Presence	Description
type	string	nullable	The requested codelist type, echoed back.
items	низа од објект	nullable	Active entries of that codelist for the tenant’s UJP environment.

400

EARH-2021 — unknown code list type; the response lists the supported ones. Checked before the tenant or the lookup service is touched.

{
  "type": "https://earhiva.mk/errors/EARH-2021",
  "title": "Unknown codelist type.",
  "status": 400,
  "code": "EARH-2021"
}

Сите полиња во телото (6)

Field	Type	Presence	Description
type	string	nullable	Address of this code in the error catalogue (RFC 7807).
title	string	nullable	Short, stable English summary of the error — the same string that appears in your log.
status	integer · int32	always	HTTP status code, repeated in the body (RFC 7807).
detail	string	nullable	What went wrong in this particular call, when there is more to say than the title.
code	string	nullable	The EARH-xxxx code. This is the contract: match on it, not on the text.
eventId	string	nullable	Only on EARH-9000. Quote it when reporting the problem — the same reference we record in our log.

401

The API key is missing, unknown, expired or revoked — EARH-1001, EARH-1002, EARH-1003. Телото е стандардното тело на грешка — исто кај сите повици. Што да се направи со секоја шифра стои во Каталог на грешки.

403

The caller’s address is outside the allowed list, or the key does not carry the IntegrationApi scope — EARH-1004, EARH-1005. Телото е стандардното тело на грешка — исто кај сите повици. Што да се направи со секоја шифра стои во Каталог на грешки.

429

The traffic limit for this key has been reached — EARH-1006. The response carries Retry-After. Телото е стандардното тело на грешка — исто кај сите повици. Што да се направи со секоја шифра стои во Каталог на грешки.

500

Unexpected error on our side — EARH-9000. The body carries eventId; quote it when reporting the problem. Телото е стандардното тело на грешка — исто кај сите повици. Што да се направи со секоја шифра стои во Каталог на грешки.