Transaction-RecentPartners-v1

A Barion wikiből
  • Tervezet
  • Üzlet
  • Informatika
  • Pénzügy
  • Jog
  • 99%
  • Online elfogadó
  • Mobil elfogadó
  • Pénztárgép
  • Feltöltés
  • Piactér
  • Nonprofit
  • Parkolas

Legutóbbi tranzakciós partnerek lekérése

GET /Transaction/RecentPartners

Ezzel az API hívással lekérdezhető az n legutóbbi felhasználó, akikkel a hívó tranzaktált. Ezek lehetnek egyaránt céges (bolti vásárlás) vagy magánszemély (pénzküldés) típusú felhasználók. A kimeneti tömbben található objektumok felépítése megegyezik az /Account/UserDetails hívásnál található struktúrával.

Ezt a hívást használja a Barion mobil alkalmazás a pénzküldési felületen a legutóbbi partnerek lekérdezésére és megjelenítésére.

Bemenet

Mező neve Mező típusa Kötelező Megkötések Alapértelmezett érték Leírás Formátum / Példa
UserName string Kötelező min. 6, max. 254 karakter nincs Az API hívás hívójának Barion azonosító e-mail címe. user@example.com
Password string Kötelező min. 8, max. 100 karakter nincs Az API hívás hívójának jelszava. EgySimaJelszo
Count integer Opcionális nincs 20 A kívánt eredmények száma (ennyi partnert szeretnénk lekérni) 5

Fontos: bár a Count paraméter opcionális, előfordulhat, hogy a hívó feleslegesen kér le alapesetben 20 partnert. Teljesítmény szempontból mindenképpen ajánlott, hogy ezt a paramétert híváskor explicit módon megadjuk, az adott körülményeknek megfelelő értékkel!

Kimenet

Mező Típus Leírás Formátum / Példa
RecentPartners UserDetails[] A legutóbbi tranzakciós partnerek adatait tartalmazó objektumokból álló tömb. UserDetails
ErrorList Errorlist A kérés során esetlegesen felmerülő hibákat tartalmazó tömb. Sikeres hívás esetén ez a tömb üres. Errorlist

Hibakódok

Hiba kódja Hiba leírása
1 Nem megfelelő felhasználónév vagy jelszó.
999 Ismeretlen hiba történt a kérés feldolgozása során.
2001 A bemeneti paraméterek valamelyike nem felelt meg az előírásoknak. Ez a hiba annyiszor szerepel(het) a kimenetben, ahány mező hibás volt. Ez esetben az ErrorMessage mezőben található a konkrét hiba: a Validation Error után látható a hibás mező megnevezése, a Value pedig a hiba leírását tartalmazza.

Példa

Bemenet

https://api.barion.com/Transaction/RecentPartners?UserName=pistike@example.com&Password=EgySimaJelszo&Count=2

Kimenet

{
    "RecentPartners": [
        {
            "LoginName": "aladar@example.com",
            "EmailAddress": "aladar@example.com",
            "FirstName": "Aladár",
            "LastName": "Horváth",
            "OrganizationName": null,
            "EmailAddresses": [
                "aladar@example.com"
            ],
            "PhoneNumbers": [],
            "ErrorList": []
        },
        {
            "LoginName": "gipszjakab@example.com",
            "EmailAddress": "gipszjakab@example.com",
            "FirstName": "Jakab",
            "LastName": "Gipsz",
            "OrganizationName": null,
            "EmailAddresses": [
                "gipszjakab@example.com"
            ],
            "PhoneNumbers": [
                "36301234567"
            ],
            "ErrorList": []
        }
    ]
}