Basis-URL
https://{tenant}.logzi.com/api/partner_user/
Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, bei einem Fehler result.code == 0. Der Partner-Ansprechpartner ist eine dem Partner zugeordnete Person — Telefonnummer, E-Mail-Adresse und Anrede können ebenfalls angegeben werden.
/api/partner_user/get
Abruf eines einzelnen Partner-Ansprechpartners anhand von ID, E-Mail-Adresse oder Partner-ID.
Query-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | int | Eindeutige Kennung des Ansprechpartners | |
email | string | Suche anhand der E-Mail-Adresse | |
partner_id | int | Kennung des Partners — der erste Ansprechpartner wird zurückgegeben |
Beispielanfrage
GET /api/partner_user/get?id=7
X-API-KEY: {ihr_api_schluessel}/api/partner_user/list
Abruf einer paginierbaren Liste von Partner-Ansprechpartnern mit Filtermöglichkeiten.
Query-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
list_offset | int | Paginierungs-Offset (Standard: 0) | |
partner_id | int | Filter nach Partner-Kennung | |
list_condition[partner_id] | int | Filter nach Partner-Kennung (im Bedingungsobjekt) | |
list_condition[name] | string | Filter nach Name (LIKE) | |
list_condition[email] | string | Filter nach E-Mail-Adresse (LIKE) | |
list_condition[telephone] | string | Filter nach Telefonnummer (nur anhand der Ziffern) | |
list_condition[fax] | string | Filter nach Faxnummer (LIKE) | |
list_condition[invocation] | string | Filter nach Anrede (LIKE) |
Beispielanfrage
GET /api/partner_user/list?partner_id=42&list_offset=0
X-API-KEY: {ihr_api_schluessel}/api/partner_user/save
Erstellen oder Ändern eines Partner-Ansprechpartners. Für einen neuen Ansprechpartner data[id] = 0.
POST-Felder — data-Objekt
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | int | 0 = neuer Ansprechpartner, >0 = Änderung | |
partner_id | int | Kennung des Partners (bei neuem Ansprechpartner erforderlich) | |
name | string | Name des Ansprechpartners | |
email | string | E-Mail-Adresse | |
telephone | string | Telefonnummer | |
fax | string | Faxnummer | |
invocation | string | Anrede (z. B. "Sehr geehrter Herr") | |
partner_user_status_id | int | Kennung des Ansprechpartner-Status | |
outer_resource_id | string | Kennung im externen System |
Beispielanfrage
POST /api/partner_user/save
X-API-KEY: {ihr_api_schluessel}
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
Löschen eines Partner-Ansprechpartners anhand der ID.
POST-Felder — data-Objekt
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | int | Kennung des zu löschenden Ansprechpartners |
Beispielanfrage
POST /api/partner_user/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "id": 7 } }Interessierst du dich für unsere Software? Schreib uns einfach!
Jetzt registrieren,
später bezahlen!
