API - Form - GET form/{id}

GET form/{id}

Verwendet für

Abrufen der Definition eines einzelnen Formulars: die Metadaten, die Parameter, die Reihenfolge der Felder und die vollständigen Feld-Definitionen (Bezeichnungen, Typen, Validierungsparameter und Übersetzungen pro Sprache).

Authentifizierung

Der Benutzer muss auf Administratorebene angemeldet sein und über die Berechtigung api_form_get verfügen. Das Formular muss zur authentifizierten Lizenz gehören.

Parameter

Beispiel

Abfrage von Formular 12.

GET api/rest/form/12

Response:
{
  "form_id": 12,
  "form_desc": "Contact",
  "title": "Neem contact op",
  "default": true,
  "params": {
    "login_required": false,
    "captcha_required": true,
    "process_form": "manual",
    "title": { "nl": "Neem contact op", "en": "Contact us" },
    "owner_id": 1234
  },
  "field_order": [ "name", "email", "message" ],
  "fields": {
    "name": {
      "field_name": "name",
      "field_display": "Naam",
      "field_type": "2",
      "field_order": "1",
      "fd_type": "text",
      "fv_type": "text"
    },
    "email": {
      "field_name": "email",
      "field_display": "E-mail",
      "field_type": "2",
      "field_order": "2",
      "fd_type": "email",
      "fv_type": "email"
    },
    "message": {
      "field_name": "message",
      "field_display": "Bericht",
      "field_type": "1",
      "field_order": "3",
      "fd_type": "textarea",
      "fv_type": "text"
    }
  }
}