Forms API

The forms API can be used to query forms managed by Techniek Nederland. The API can for example be used to retrieve a list of all forms, to retrieve a specific form or to retrieve all relevant forms for an installation given an ETIM product class. For the documentation on the forms API, please see https://formsapi.technieknederland.nl/swagger/index.html.

Get a list of relevant forms

GET https://formsapi.technieknederland.nl/api/v1/Forms/Latest

Returns a list of forms relevant for you installation

Example request:

GET /api/v1/Forms/All?classCode=EC010232 HTTP/1.1
Host: formsapi.technieknederland.nl
Accept: application/json
Authorization: OAuth token to authenticate

Example response (excerpt):

HTTP/1.1 200 OK
Content-Type: text/javascript

[
  {
      "code": "FGO00002",
      "version": 3,
      "title": "Melding onveilige situatie gas",
      "formCode": "MBO_GAS",
      "publisher": "Techniek Nederland",
      "publisherLink": "https://www.technieknederland.nl"
  }
]

Request Headers

• Authorization – OAuth token to authenticate

Query Parameters

• classCode (string) – The ETIM Class to filter forms for

Get the form itself

GET https://formsapi.technieknederland.nl/api/v1/Form/[code]/[version]/

Returns the requested form

Example request:

GET /api/v1/Form/FGO00002/2/ HTTP/1.1
Host: formsapi.technieknederland.nl
Accept: application/json
Authorization: OAuth token to authenticate

Example response (excerpt):

HTTP/1.1 200 OK
Content-Type: text/javascript

  {
      "form": {
          "display": "form",
          "components": [
              {
                  "input": true,
                  "optionsLabelPosition": "right",
                  "inline": false,
                  "type": "radio",
                  "values": [
                      {
                          "value": "direct",
                          "label": "Direct gevaar"
                      },
                      {
                          "value": "in_time",
                          "label": "Gevaar op termijn"
                      },
                      {
                          "value": "possible",
                          "label": "Mogelijk gevaar"
                      }
                  ],
                  "key": "seriousness",
                  "label": "Wat is de ernst van de situatie?"
              },
              {
                  "input": true,
                  "type": "textarea",
                  "key": "situation",
                  "label": "Beschrijf de situatie"
              },
              {
                  "label": "Voeg foto's van de situatie toe",
                  "itemLabel": "Foto",
                  "reorder": false,
                  "addAnotherPosition": "bottom",
                  "defaultOpen": false,
                  "layoutFixed": false,
                  "enableRowGroups": false,
                  "initEmpty": false,
                  "defaultValue": [
                      {}
                  ],
                  "key": "photos",
                  "type": "datagrid",
                  "input": true,
                  "components": [
                      {
                          "label": "Foto",
                          "tableView": true,
                          "key": "photoId",
                          "type": "photo",
                          "input": true
                      },
                      {
                          "label": "Toelichting",
                          "tableView": true,
                          "key": "description",
                          "type": "textarea",
                          "input": true
                      }
                  ]
              },
              {
                  "input": true,
                  "type": "textarea",
                  "key": "performed_emergency_operation",
                  "label": "Verrichtte noodhandeling"
              },
              {
                  "input": true,
                  "type": "textarea",
                  "key": "possible_causer",
                  "label": "Mogelijke veroorzaker"
              },
              {
                  "input": true,
                  "optionsLabelPosition": "right",
                  "inline": true,
                  "type": "radio",
                  "values": [
                      {
                          "label": "Ja",
                          "value": "ja"
                      },
                      {
                          "label": "Nee",
                          "value": "nee"
                      }
                  ],
                  "key": "reporter_keep_up_to_date",
                  "label": "Wilt u op de hoogte gehouden worden?"
              },
              {
                  "input": true,
                  "optionsLabelPosition": "right",
                  "inline": true,
                  "type": "radio",
                  "values": [
                      {
                          "label": "Ja",
                          "value": "ja"
                      },
                      {
                          "label": "Nee",
                          "value": "nee"
                      }
                  ],
                  "key": "eigenaar-op-de-hoogte-houden",
                  "label": "Eigenaar op de hoogte houden?"
              }
          ]
      },
      "code": "FGO00002",
      "version": 3,
      "title": "Melding onveilige situatie gas",
      "formCode": "MBO_GAS",
      "publisher": "Techniek Nederland",
      "publisherLink": "https://www.technieknederland.nl"
  }

Request Headers

• Authorization – OAuth token to authenticate