API - Form - GET form/{id}

GET form/{id}

Gebruikt voor

Ophalen van de definitie van één formulier: de metadata, de parameters, de volgorde van de velden en de volledige veld-definities (labels, types, validatie-parameters en vertalingen per taal).

Authenticatie

Gebruiker dient ingelogd te zijn op beheerdersniveau en te beschikken over het recht api_form_get. Het formulier moet bij de geauthenticeerde licentie horen.

Parameters

Voorbeeld

Opvragen van formulier 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"
    }
  }
}