You are here

Home » API reference » Webform REST 8.2

README.txt in Webform REST 8.2

Same filename and directory in other branches
  1. 8.3 README.txt
  2. 8 README.txt
  3. 4.x README.txt
Webform REST 2.x

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.

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/{sid}?_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/{sid}?_format=json

File

README.txt
View source 
  1. Webform REST 2.x

  2. 

  3. Retrieve and submit webforms via REST.

  4. 

  5. 1. Enable module

  6. 2. Enable REST resource "Webform Submit"

  7. 3. Enable REST resource "Webform Elements"

  8. 4. Enable REST resource "Webform Fields"

  9. 5. Enable REST resource "Webform Submission"

  10. 

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

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

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

  14. "Webform Elements", etc.

  15. 

  16. Retrieve Webform Elements

  17. -------------------------

  18. 

  19. Returns all form elements including render array.

  20. 

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

  22. 

  23. Retrieve Webform Fields

  24. -----------------------

  25. 

  26. Returns form fields.

  27. 

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

  29. 

  30. Submit Webform

  31. --------------

  32. 

  33. POST /webform_rest/submit

  34. 

  35. Example POST data:

  36. 

  37. {

  38.   "webform_id": "my_webform",

  39.   "checkboxes_field": [

  40.     "Option 3",

  41.     "Option 5"

  42.    ],

  43.    "integer_field": 3,

  44.    "radio_field": "Mail",

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

  46. }

  47. 

  48. Update Webform Submission

  49. -------------------------

  50. 

  51. PATCH /webform_rest/{webform_id}/submission/{sid}?_format=json

  52. 

  53. Example PATCH data:

  54. 

  55. {

  56.   "checkboxes_field": [

  57.     "Option 3",

  58.     "Option 5"

  59.    ],

  60.    "integer_field": 3,

  61.    "radio_field": "Mail",

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

  63. }

  64. 

  65. Retrieve Webform Submission

  66. ---------------------------

  67. 

  68. GET /webform_rest/{webform_id}/submission/{sid}?_format=json