You are here

Home » API reference » Webform REST 4.x

README.txt in Webform REST 4.x

Same filename and directory in other branches
  1. 8.3 README.txt
  2. 8 README.txt
  3. 8.2 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Maintainers


INTRODUCTION
------------

Retrieve and submit webforms via REST.

1. Enable module
2. Enable REST resource "Webform Submit"
3. Enable REST resource "Webform Elements"
4. Enable REST resource "Webform Fields"
5. Enable REST resource "Webform Submission"

Note: This module does not provide UI to enable
REST resources. Use restui: https://www.drupal.org/project/restui
module, for example, to enable resource "Webform Submit",
"Webform Elements", etc.


REQUIREMENTS
------------

This module requires:
- webform
- restui


INSTALLATION
------------

 * Install as you would normally install a contributed Drupal module. Visit
   https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules
   for further information.


CONFIGURATION
-------------

- Retrieve Webform Elements

Returns all form elements including render array.
GET /webform_rest/{webform_id}/elements?_format=json

- Retrieve Webform Fields

Returns form fields.
GET /webform_rest/{webform_id}/fields?_format=json

- Submit Webform

POST /webform_rest/submit
Example POST data:
{
  "webform_id": "my_webform",
  "checkboxes_field": [
    "Option 3",
    "Option 5"
   ],
   "integer_field": 3,
   "radio_field": "Mail",
   "email": "myemail@mydomain.com.au"
}

- Update Webform Submission

PATCH /webform_rest/{webform_id}/submission/{uuid}?_format=json
Example PATCH data:
{
  "checkboxes_field": [
    "Option 3",
    "Option 5"
   ],
   "integer_field": 3,
   "radio_field": "Mail",
   "email": "myemail@mydomain.com.au"
}

- Retrieve Webform Submission

GET /webform_rest/{webform_id}/submission/{uuid}?_format=json


MAINTAINERS
-----------

Current maintainers:
* Ian McLean (imclean) - https://www.drupal.org/u/imclean
 * Debora Antunes (dgaspara) - https://www.drupal.org/u/dgaspara
 * João Marques (joaomarques736) - https://www.drupal.org/u/joaomarques736

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Configuration

  8.  * Maintainers

  9. 

  10. 

  11. INTRODUCTION

  12. ------------

  13. 

  14. Retrieve and submit webforms via REST.

  15. 

  16. 1. Enable module

  17. 2. Enable REST resource "Webform Submit"

  18. 3. Enable REST resource "Webform Elements"

  19. 4. Enable REST resource "Webform Fields"

  20. 5. Enable REST resource "Webform Submission"

  21. 

  22. Note: This module does not provide UI to enable

  23. REST resources. Use restui: https://www.drupal.org/project/restui

  24. module, for example, to enable resource "Webform Submit",

  25. "Webform Elements", etc.

  26. 

  27. 

  28. REQUIREMENTS

  29. ------------

  30. 

  31. This module requires:

  32. - webform

  33. - restui

  34. 

  35. 

  36. INSTALLATION

  37. ------------

  38. 

  39.  * Install as you would normally install a contributed Drupal module. Visit

  40.    https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules

  41.    for further information.

  42. 

  43. 

  44. CONFIGURATION

  45. -------------

  46. 

  47. - Retrieve Webform Elements

  48. 

  49. Returns all form elements including render array.

  50. GET /webform_rest/{webform_id}/elements?_format=json

  51. 

  52. - Retrieve Webform Fields

  53. 

  54. Returns form fields.

  55. GET /webform_rest/{webform_id}/fields?_format=json

  56. 

  57. - Submit Webform

  58. 

  59. POST /webform_rest/submit

  60. Example POST data:

  61. {

  62.   "webform_id": "my_webform",

  63.   "checkboxes_field": [

  64.     "Option 3",

  65.     "Option 5"

  66.    ],

  67.    "integer_field": 3,

  68.    "radio_field": "Mail",

  69.    "email": "myemail@mydomain.com.au"

  70. }

  71. 

  72. - Update Webform Submission

  73. 

  74. PATCH /webform_rest/{webform_id}/submission/{uuid}?_format=json

  75. Example PATCH data:

  76. {

  77.   "checkboxes_field": [

  78.     "Option 3",

  79.     "Option 5"

  80.    ],

  81.    "integer_field": 3,

  82.    "radio_field": "Mail",

  83.    "email": "myemail@mydomain.com.au"

  84. }

  85. 

  86. - Retrieve Webform Submission

  87. 

  88. GET /webform_rest/{webform_id}/submission/{uuid}?_format=json

  89. 

  90. 

  91. MAINTAINERS

  92. -----------

  93. 

  94. Current maintainers:

  95. * Ian McLean (imclean) - https://www.drupal.org/u/imclean

  96.  * Debora Antunes (dgaspara) - https://www.drupal.org/u/dgaspara

  97.  * João Marques (joaomarques736) - https://www.drupal.org/u/joaomarques736