Handbuch i-Reserve - API - Config GET config/custfields

Home Funktionale Informationen Verfügbare APIs API-Config

Documentatie

difficulty level:

GET config/custfields

Verwendet für

Abrufen der Konfiguration für Kundenfelder. Die Ausgabe wird anhand des aktuellen Benutzers bestimmt. Eine anonyme Benutzeranfrage ist möglich. In diesem Fall werden Standardeinstellungen gesendet. Daher wird empfohlen, sich über die User-API einzuloggen.

Authentifizierung

Anonym oder Benutzer.

Parameter

Parameter	Beschreibung	Erforderlich	Beispiel
lang		Nein	dutch

Ausgabe

Parameter	Beschreibung	Beispiel
name	Der Name des Feldes	dutch
type	1=Pflicht, 2=Optional	1
checks	Optionaler regulärer Ausdruck	Zum Prüfen der PLZ: ^[0-9]{4}[ ]{0,1}[A-Z]{2}$"
length	Die Länge des Textfeldes	20
ct_type	Feldtyp der benutzerdefinierten Tabelle
ct_field	Feldname der benutzerdefinierten Tabelle
display	Der Anzeigewert	E-mail

Antwortcodes

200 OK

Beispiel

Abrufen der Konfiguration für Kundenfelder.

GET api/rest/config/custfields

Response: 
[
  {
    "name": "email",
    "type": "1",
    "checks": "^ *[",
    "length": "30",
    "ct_type": "",
    "ct_field": "",
    "display": "E-mail"
  },
  {
    "name": "initials",
    "type": "2",
    "checks": "",
    "length": "8",
    "ct_type": "",
    "ct_field": "",
    "display": "Voornaam"
  }
]