You are here

Home » API reference » Webform REST 8.3

README.txt in Webform REST 8.3

Same filename and directory in other branches
  1. 8 README.txt
  2. 8.2 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"

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. Retrieve Webform Elements

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

  13. 

  14. Returns all form elements including render array.

  15. 

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

  17. 

  18. Retrieve Webform Fields

  19. -----------------------

  20. 

  21. Returns form fields.

  22. 

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

  24. 

  25. Submit Webform

  26. --------------

  27. 

  28. POST /webform_rest/submit

  29. 

  30. Example POST data:

  31. 

  32. {

  33.   "webform_id": "my_webform",

  34.   "checkboxes_field": [

  35.     "Option 3",

  36.     "Option 5"

  37.    ],

  38.    "integer_field": 3,

  39.    "radio_field": "Mail",

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

  41. }

  42. 

  43. Update Webform Submission

  44. -------------------------

  45. 

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

  47. 

  48. Example PATCH data:

  49. 

  50. {

  51.   "checkboxes_field": [

  52.     "Option 3",

  53.     "Option 5"

  54.    ],

  55.    "integer_field": 3,

  56.    "radio_field": "Mail",

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

  58. }

  59. 

  60. Retrieve Webform Submission

  61. ---------------------------

  62. 

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