Partner kapcsolattartó API

Partnerhez rendelt kapcsolattartó személyek kezelése — lekérés, létrehozás, módosítás és törlés

Alap URL

https://{tenant}.logzi.com/api/partner_user/

Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0. A partner kapcsolattartó a partnerhez rendelt személy — telefonszám, e-mail cím és megszólítás is megadható.

GET /api/partner_user/get

Egyetlen partner kapcsolattartó lekérése azonosító, e-mail cím vagy partner azonosító alapján.

Query paraméterek

ParaméterTípusKötelezőLeírás
idintKapcsolattartó egyedi azonosítója
emailstringE-mail cím alapján keresés
partner_idintPartner azonosítója — az első kapcsolattartó kerül vissza

Példa kérés

GET /api/partner_user/get?id=7
X-API-KEY: {az_api_kulcsod}
GET /api/partner_user/list

Partner kapcsolattartók lapozható listájának lekérése szűrési lehetőségekkel.

Query paraméterek

ParaméterTípusKötelezőLeírás
list_offsetintLapozás eltolása (alapértelmezett: 0)
partner_idintSzűrés partner azonosítóra
list_condition[partner_id]intSzűrés partner azonosítóra (feltétel objektumban)
list_condition[name]stringSzűrés névre (LIKE)
list_condition[email]stringSzűrés e-mail címre (LIKE)
list_condition[telephone]stringSzűrés telefonszámra (csak számjegyek alapján)
list_condition[fax]stringSzűrés fax számra (LIKE)
list_condition[invocation]stringSzűrés megszólításra (LIKE)

Példa kérés

GET /api/partner_user/list?partner_id=42&list_offset=0
X-API-KEY: {az_api_kulcsod}
POST /api/partner_user/save

Partner kapcsolattartó létrehozása vagy módosítása. Új kapcsolattartóhoz data[id] = 0.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idint0 = új kapcsolattartó, >0 = módosítás
partner_idintA partner azonosítója (új kapcsolattartónál kötelező)
namestringKapcsolattartó neve
emailstringE-mail cím
telephonestringTelefonszám
faxstringFax szám
invocationstringMegszólítás (pl. "Tisztelt Uram")
partner_user_status_idintKapcsolattartó státusz azonosítója
outer_resource_idstringKülső rendszer azonosítója

Példa kérés

POST /api/partner_user/save
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "partner_id": 42,
    "name": "Kovács Béla",
    "email": "kovacs.bela@minta.hu",
    "telephone": "+36301234567",
    "invocation": "Tisztelt Kovács Úr!"
  }
}
POST /api/partner_user/delete

Partner kapcsolattartó törlése azonosító alapján.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idintA törlendő kapcsolattartó azonosítója

Példa kérés

POST /api/partner_user/delete
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{ "data": { "id": 7 } }

Vedd fel a kapcsolatot velünk

Érdeklődsz a szoftverünkkel kapcsolatban, írj bátran!

Segítségre van szükséged?

Ha nem találod a választ és szükséged van segítségre

Regisztrációdat hozd létre most,
fizess később!

Próbáld ki 3 napig ingyen, kockázatok és kötöttségek nélkül!