Betreuergruppen-PLZ
6 Endpunkte unter /api/rest/2.0
Agent postal code territories (Betreuergruppen PLZ-Zuordnung)
Endpunkte
Alle Pfade sind relativ zur Basis /api/rest/2.0 Ihrer ameax-Installation. Die Antworten folgen dem JSON:API-Format mit data, links und meta.
| Methode | Pfad | Beschreibung |
|---|---|---|
GET |
/agent-territories |
List all agent-territorys |
POST |
/agent-territories |
Create a agent-territory |
GET |
/agent-territories/{id} |
Get a agent-territory |
PUT |
/agent-territories/{id} |
Update a agent-territory |
PATCH |
/agent-territories/{id} |
Partially update a agent-territory |
DELETE |
/agent-territories/{id} |
Delete a agent-territory |
Felder
Diese Felder liefert die API zu Betreuergruppen-PLZ. Dazu kommen die Zusatzfelder Ihrer eigenen Installation — sie werden nach denselben Regeln geprüft wie in der Oberfläche und erscheinen in der Spezifikation Ihres Mandanten.
| Feld | Typ | Beschreibung |
|---|---|---|
agent_id |
integer | Agent ID this territory belongs to |
country_code |
string | ISO country code (e.g., DE, AT, CH) |
mode |
string | Matching mode: "topdown" for prefix matching, "fromtill" for range matching |
postal_code |
string | Postal code prefix (for topdown mode, e.g., "91" matches 91xxx) |
postal_code_from |
string | Start of postal code range (for fromtill mode) |
postal_code_to |
string | End of postal code range (for fromtill mode) |
Zugriff
Jede Anfrage braucht ein API-Token im Kopf Authorization: Bearer <token>, wahlweise als Basic-Auth mit dem Benutzernamen api und dem Token als Passwort.
Das Token hängt an einem Benutzer und erbt dessen Rechte: Was dieser Benutzer in der Oberfläche nicht sehen darf, liefert die API auch nicht. Zusätzlich lassen sich je Token ein Ablaufdatum und eine IP-Beschränkung hinterlegen. Mehr dazu auf der API-Übersicht.
Anbindung besprechen.
Sie wollen ein System anbinden und wissen nicht, ob die Schnittstelle abdeckt, was Sie brauchen? Wir schauen es uns gemeinsam an — kostenlos und ohne Verpflichtung.