5. Hibakódok a válaszban

Alapvetően három féle választ ad az API.

5.1. „standard” hiba

Minden olyan esetben ilyen hibát ad a rendszer, amikor a parancsok végrehajtása nem lehetséges. Például szintaktikai hibás az xml, esetleg rossz a hitelesítésnél megadott XML jelszó, stb. Szintaktikai hibás XML kérésre példa válasz:

<api xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" lang="hu" version="1.1" xsi:schemaLocation="">
    <hibak tipus="standard">
        <hiba kod="2">Szintaktikai hiba van a küldött XML-ben</hiba>
    </hibak>
</api>
Kód Üzenet
1 TTP Post kérésben el kell küldenie az XML fájlt xml néven
2 Szintaktikai hiba van a küldött XML-ben
3 Nem lehet letölteni az XML fájlt a %url% URL címről
4 HTTP Get kérésben meg kell adni az XML URL-t xml néven
5 Belső hiba történt, kérem értesítse az üzemeltetőt
6 Sikertelen hitelesítés: rossz felhasználónév, vagy jelszó
7 A megadott címről nem tölthető le az XML fájl
9 A felhasználó jelenleg nem tartozik egy aktív irodához sem.
10 Az API ideiglenesen nem elérhető
11 A beküldött XML hibákat tartalmaz és már egyszer beküldte az elmúlt %seconds% másodpercben. Kérjük javítsa a hibákat és utána küldje újra
12 Összesen %seconds% másodperc alatt nem küldhet %count% darabnál több kérést az API feldolgozónak
13 Az XML nem felel meg a sémának
14 Ennek az XML-nek a feldolgozása már folyamatban van

5.2. „validation” hiba

amikor a beküldött xml nem felel meg az api.xsd sémának, azaz validáció hibás. Validáció hibás XML kérésre példa válasz (a parancsok tag hiányzik, csak hitelesítés rész van megadva):

<api xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" lang="hu" version="1.1" xsi:schemaLocation="">
    <hibak tipus="validation">
        <hiba tipus="Error" kod="1871" hely="XML">
            <sor>7</sor>
            <oszlop>0</oszlop>
            <uzenet>
                Element 'ingatlan_felvetel': Missing child element(s). Expected is one of ( projekthez_rendeles, regio_azonosito, statusz, muvelet, iranyar, penznem, ar_idoszak, kaucio_tipusa, iranyitoszam, kiemelt ).
            </uzenet>
            <pozicio><ingatlan_felvetel></pozicio>
        </hiba>
    </hibak>
</api>

5.3. Egyes parancsokra adott hiba

Pontosabban a nullától eltérő kóddal visszaadott válasz számít hibásnak. Példa ingatlan módosításra, ha nincs még ilyen azonosítójú ingatlan:

<api xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://ingatlanok.hu/answer.xsd">
    <valasz kod="7">
        <uzenet>Nincs ilyen átviteli azonosítójú ingatlan</uzenet>
        <hibak></hibak>
    </valasz>
</api>
Kód Üzenet
1 Adatbázis hiba történt
2 Nincs ilyen azonosítójú %entity%
3 Az aktuális felhasználó jogosultsági szintje nem elég a parancs végrehajtásához
4 Nincs jogosultsága a parancs végrehajtásához, vagy hibásan adta meg a(z) %field% XML tagot
5* Egy, vagy több XML tag értéke hibákat tartalmaz
7 Nincs ilyen átviteli azonosítójú ingatlan
8 Egynél több ilyen átviteli azonosítójú ingatlan van felvéve. Kérem értesítse az üzemeltetőt!
9 Nincs ilyen átviteli azonosítójú értékesítő
10 Egynél több ilyen átviteli azonosítójú értékesítő van felvéve. Kérem értesítse az üzemeltetőt!
11 A megadott átviteli azonosítóval már van kép felvéve
12 A megadott URL nem elérhető
13 A kép mentése nem sikerült
14 A megadott átviteli azonosítójú kép nem létezik
15 A képet nem sikerült törölni
16 Egy XML kérés legfeljebb %max_count% darab parancsot tartalmazhat, a szerver %current_count% darabot kapott
17 Adatbázis hiba történt
18 A megadott kép mérete nem lépheti túl a %size% értéket
19 A megadott kép nem szabványos formátumú, vagy nem támogatott
20 Az „entitas” tagban megadott azonosító nem létezik, vagy törölt entitásra mutat
21 A képet nem lehet letölteni a megadott URL címről
22** Az iroda azonosítóval megadott iroda nincs hozzárendelve a hitelesített felhasználóhoz, vagy inaktív
23** Már van ilyen irodán belüli azonosító felvéve
24** Már van ilyen átviteli azonosító felvéve
25** Elérte a felvehető egyedek számát, nem vehet fel többet
26** A megadott értékesítő nincs az irodához rendelve
27 Nincs ilyen átviteli azonosítójú projekt
28 Egynél több ilyen átviteli azonosítójú projekt van felvéve. Kérem értesítse az üzemeltetőt!
29 A megadott %entity% nem tartozik az aktuális felhasználóhoz
30** Elérte a projekthez felvehető egyedek számát, nem rendelhet több ingatlant hozzá
31 Elérte az ingatlanhoz felvehető maximális képszámot, nem vehet fel több képet
32 Hiba történt a projekt validálása során (%field%)
33 A megadott felhasználónév foglalt a rendszerben
34 A felhasználónév és a belső azonosító nincs szinkronban
35 Sem belső, sem átviteli azonosító nem lett megadva
36 Hiba történt a kép feltöltése közben
37 Hiba történt a kép módosítása közben
38 Hiba történt a kép törlése közben
39 Az adatfeldolgozás közben hiba lépett fel
40 A megadott e-mail címmel már van értékesítő felvéve
41 Az értékesítő által feltölthető maximális ingatlanszám nem lépheti túl az iroda előfizetésében meghatározott maximális ingatlanszámot (%max%)
42 Hibás értékesítő adatok
43 A(z) %entity_id% azonosítójú ingatlan nem törölhető XML kérésen keresztül
44 Az értékesítőhöz már létezik kép, módosításhoz törölje az aktuális képet
45 A megadott e-mail címmel már van felvéve értékesítő az adott irodába
46 Hibás értékesítő jogosultsági szint
47 Nincs ingatlan típus megadva
48 Hiba a kép letöltése közben: A kép nem található
49 Hiba a kép letöltése közben: Érvénytelen átirányítás
50 Nincs értékesítő a megadott azonosítóval(Lehetséges hogy átviteli azonosítóval próbálkozik, viszont atviteli_azonosito helyett id szerepel az ertekesito_azonositas résznél.)
51 A hirdetés nem tölthető fel az irodához
52 Elérte az ingatlanhoz felvehető maximális videószámot, nem vehet fel több videót
53 Van már ilyen hozzárendelt videó a hirdetésnél
54 Hibás videó hivatkozás
55 A keresett videó nem található
255 Egyéb hiba történt a feldolgozás során
* Ez egy általános hiba, ami azt jelenti, hogy több hibát is jelezhet egyszerre, ezek a válaszban a <hibak></hibak> tagokban lesznek felsorolva <hiba kod=”hibakód”>Hibaüzenet szövge</hiba> formában.
** Jelenleg ezek a hibák fordulhatnak elő az 5-ös hibakód esetén