Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Use /entity routing instead of /user


Excerpt

Submit form data for a user

...


Endpoint ID:

8001

Method:

Image Modified

URL:

POST

/forms/

user

entity/

dp-key

id/{

dp

entity-

key

id}/form/{form-id}

POST

/forms/

userdp

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

 


entity-

keydialogportal™ master key that

id

Rubiq entity ID that uniquely identifies the account to submit

forms data 

a form for


ext-key

External key that uniquely identifies the account to submit a form

data 

for


ext-typeType of external key


form-id

Numeric value that identifies the form

Request body:

A JSON

data with information as 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.

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


Request body:

JSON data with same JSON array that was received

.

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

 

 


Status codes:

201

Submit

Form

Data

data submitted successfully

 


303

Form

already Submitted

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.1User not found
404.2External user could not be found
404.4Form not found