Kihagyás

API válaszmezőinek részletes leírása

Válasz alapegység

Uniformitás

Az api válaszai egyéges formátumban kerülnek visszadásra, ezáltal támogatva ez egyszerű és gyors integrálhatóságot. A válaszok a keresés típusától függetlenül mindig egy "keretben" érkeznek - ez egy fix formátum, amennyiben nincs találat egy keresésre, ez az alap válasz törzs mindenképpen - kivéve hiba esetén - visszadásra kerül.

Keret mezőinek leírása

Válasz mező Leírás
current_page Jelenlegi oldal, szám értékű mező, jelzi, hogy hányadik oldal került visszaadásra a válaszok közül
has_next Egy flag, jelzés arra, hogy lehet még további válasz oldalakat lekérdezni az api-ból (amennyiben a válaszok mennyisége meghaladta a limit-et), részletes leírás a több oldalas lekérdezésről a pagináció dokumentációjában található
results Lista, mely a találatokat tartalmazza.
Amennyiben valamelyik specifikus keresést alkalmaztuk, például regisztrációs szám alapján történő keresést, akkor az esetek túényomó részében 1 eleme lesz a listának.
Kevésbé specifikus, több választ is generáló keresés esetén (például név keresés) a lista elemeinek száma az esetek többségében nagyobb lesz mint 1.
Amennyiben nincs találat, a válasz lista üres lesz.

Results lista

Mezők vizsgálhatósága

A válasz mezőinek kulcsai egységesek minden vállakozási forma esetén, viszont ezek a kulcsok nem minden esetben értelmezhetőek egyes vállakozási formáknál. Ilyen esetben a rendszer null értéket ad az adott kulcs alatt vissza.
Amennyiben az egyik mező hiányzik, viszont értelmezhető az adott vállalkozás típusnál ebben az esetben, listák esetén üres lista ([]), szöveges mezők esetén pedig ("N/A") kerül visszaadásra az adott kulcs alatt.

Egy listaelem mezőinek leírása

Válasz mező Leírás
address
bank_accounts
founded_at
full_name
main_activities
registration_number
representatives
short_name
social_tax_number
status_code
tax_number
type 
{
    "current_page": 1, //(1)
    "has_next": false, //(2)
    "results": [ //(3)
        {
            "type": "companies", //(4)
            "status_code": 1, //(5)
            "full_name": "Cégjelző Céginformációs Korlátolt Felelősségű Társaság", //(6)
            "short_name": "Cégjelző Kft.", //(7)
            "address": "1124 Budapest, Kempelen Farkas Utca 1. Fszt. 3.", //(8)
            "tax_number": "26163190-2-43", //(9)
            "bank_accounts": [
                {
                    "bank_account": "10404072-50526871-56691003" //(10)
                }
            ],
            "founded_at": "2017-10-25", //(11)
            "registration_number": "01-09-305302", //(12)
            "social_tax_number": "HU26163190", //(13)
            "representatives": [
                {
                    "name": "Farkas Dezső" //(14)
                }
            ],
            "main_activities": [
                "6311 '08 Adatfeldolgozás, web-hoszting szolgáltatás" //(15)
            ]
        }
    ]
}
  1. Jelenleg megjelenített oldal száma, pl. név keresésnél, vagy bankszámla szám részletnél történő keresésnél előfordulhat, hogy több találat keletkezik, mint amennyit az API egyben vissza tudna adni, részletesen erről a mechanizmusról a "Pagináció" fejezetben lehet többet olvasni.
  2. A paginácó mechanizmus használatához szükséges bool érték
  3. Találati lista. Amennyiben üres lista az eredmény, nincs találat.
  4. A vállalkozás típusa, jelenleg a companies - társas vállalkozás, self_employed - egyéni vállalkozó, budget_orgs - költségvetési szerv, civil_orgs - civil szervezet értékek közül vehet fel egyet
  5. A vállalkozás állapota - 0 érték esetén a vállalkozás megszűnt, 1 érték esetén működik, 2 érték esetén szünetelteti tevékenységét (csak egyéni vállalkozóknál fordulhat elő)
  6. A vállakozás teljes neve
  7. A vállalkozás rövid neve, csak társas vállalkozások illetve civil szervezetek esetén értelmezhető mező
  8. A vállalkozás székhelye
  9. A vállakozás adószáma
  10. A vállalkozás bankszámlaszáma listába foglalva
  11. A vállalkozás alapításának / bejegyzésének ideje
  12. A vállalkozás nyilvántartási száma, formátuma a vállalkozási formától függ
  13. A vállakozás közösségi adószáma
  14. A vállalkozás képviseletére jogosult(ak) listája, nem minden vállalkozás típusnál értelmezhető mező
  15. A vállalkozás főtevékenysége(i)