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.
/api/partner_user/get
Získanie jednej kontaktnej osoby partnera podľa identifikátora, e-mailovej adresy alebo identifikátora partnera.
Parametre dopytu
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Jedinečný identifikátor kontaktnej osoby | |
email | string | Vyhľadávanie podľa e-mailovej adresy | |
partner_id | int | Identifiká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}
/api/partner_user/list
Získanie stránkovaného zoznamu kontaktných osôb partnera s možnosťami filtrovania.
Parametre dopytu
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_offset | int | Posun stránkovania (predvolene: 0) | |
partner_id | int | Filtrovanie podľa identifikátora partnera | |
list_condition[partner_id] | int | Filtrovanie podľa identifikátora partnera (v objekte podmienok) | |
list_condition[name] | string | Filtrovanie podľa mena (LIKE) | |
list_condition[email] | string | Filtrovanie podľa e-mailovej adresy (LIKE) | |
list_condition[telephone] | string | Filtrovanie podľa telefónneho čísla (iba na základe číslic) | |
list_condition[fax] | string | Filtrovanie podľa faxového čísla (LIKE) | |
list_condition[invocation] | string | Filtrovanie 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}
/api/partner_user/save
Vytvorenie alebo úprava kontaktnej osoby partnera. Pre novú kontaktnú osobu data[id] = 0.
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | 0 = nová kontaktná osoba, >0 = úprava | |
partner_id | int | Identifikátor partnera (povinné pri novej kontaktnej osobe) | |
name | string | Meno kontaktnej osoby | |
email | string | E-mailová adresa | |
telephone | string | Telefónne číslo | |
fax | string | Faxové číslo | |
invocation | string | Oslovenie (napr. „Vážený pán“) | |
partner_user_status_id | int | Identifikátor stavu kontaktnej osoby | |
outer_resource_id | string | Identifiká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!"
}
}
/api/partner_user/delete
Vymazanie kontaktnej osoby partnera podľa identifikátora.
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifiká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 } }
Zaregistruj sa teraz,
zaplať neskôr!