API kontaktných osôb partnera

Správa kontaktných osôb priradených k partnerovi — získanie, vytvorenie, úprava a vymazanie

Základná URL

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

Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. Kontaktná osoba partnera je osoba priradená k partnerovi — je možné uviesť aj telefónne číslo, e-mailovú adresu a oslovenie.

GET /api/partner_user/get

Získanie jednej kontaktnej osoby partnera podľa identifikátora, e-mailovej adresy alebo identifikátora partnera.

Parametre dopytu

ParameterTypPovinnéPopis
idintJedinečný identifikátor kontaktnej osoby
emailstringVyhľadávanie podľa e-mailovej adresy
partner_idintIdentifikátor partnera — vráti sa prvá kontaktná osoba

Príklad požiadavky

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

Získanie stránkovaného zoznamu kontaktných osôb partnera s možnosťami filtrovania.

Parametre dopytu

ParameterTypPovinnéPopis
list_offsetintPosun stránkovania (predvolene: 0)
partner_idintFiltrovanie podľa identifikátora partnera
list_condition[partner_id]intFiltrovanie podľa identifikátora partnera (v objekte podmienok)
list_condition[name]stringFiltrovanie podľa mena (LIKE)
list_condition[email]stringFiltrovanie podľa e-mailovej adresy (LIKE)
list_condition[telephone]stringFiltrovanie podľa telefónneho čísla (iba na základe číslic)
list_condition[fax]stringFiltrovanie podľa faxového čísla (LIKE)
list_condition[invocation]stringFiltrovanie podľa oslovenia (LIKE)

Príklad požiadavky

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

Vytvorenie alebo úprava kontaktnej osoby partnera. Pre novú kontaktnú osobu data[id] = 0.

POST polia — objekt data

PoleTypPovinnéPopis
idint0 = nová kontaktná osoba, >0 = úprava
partner_idintIdentifikátor partnera (povinné pri novej kontaktnej osobe)
namestringMeno kontaktnej osoby
emailstringE-mailová adresa
telephonestringTelefónne číslo
faxstringFaxové číslo
invocationstringOslovenie (napr. „Vážený pán“)
partner_user_status_idintIdentifikátor stavu kontaktnej osoby
outer_resource_idstringIdentifikátor externého systému

Príklad požiadavky

POST /api/partner_user/save
X-API-KEY: {vas_api_kluc}
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

Vymazanie kontaktnej osoby partnera podľa identifikátora.

POST polia — objekt data

PoleTypPovinnéPopis
idintIdentifikátor kontaktnej osoby na vymazanie

Príklad požiadavky

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

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

Kontaktuj nás

Zaujíma ťa náš softvér? Pokojne nám napíš!

Potrebuješ pomoc?

Ak nevieš nájsť odpoveď a potrebuješ pomoc

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!