Submit form data for a user

Endpoint ID:

8001

Method:

URL:

/forms/entity/id/{entity-id}/form/{form-id}
/forms/entity/ext-key/{ext-key}/{ext-type}/form/{form-id}

entity-id

Rubiq entity ID that uniquely identifies the account to submit a form for

ext-key

External key that uniquely identifies the account to submit a form for

ext-type

Type of external key

form-id

Numeric value that identifies the form

Request body:

A JSON array of form field values. The value data types depend on the field types - text strings for "Text" fields, integer options for "Singlechoice" fields and arrays of integer options for "Multichoice" fields.

Endpoint 8006: Enumerate fields can be used to determine the fields and datatypes required for the form.

Example

[
   {
      "fieldID": 87,
      "value": "This is a text field"
   },
   {
      "fieldID": 88,
      "value": 134
   },
   {
      "fieldID": 89,
      "value": [ 136, 138 ]
   }
]

Request body:

JSON data with same JSON array that was received

Example

[
   {
      "fieldID": 87,
      "value": "This is a text field"
   },
   {
      "fieldID": 88,
      "value": 134
   },
   {
      "fieldID": 89,
      "value": [ 136, 138 ]
   }
]

Status codes:

201

Form data submitted successfully

303

Form data already submitted for this account

400

Invalid data: field was not recognized

404

Form or account not found.

The following sub codes may be returned:

404.1	User not found
404.2	External user could not be found
404.4	Form not found

Browser not supported