Retrieve a list of fields for a form
Endpoint ID: | 8006 | |||||||
Method: | GET | |||||||
URL: | /data/forms/dp-key/{dp-key}/{form-id} | |||||||
| dp-key | dialogportal™ master key that uniquely identifies the account to retrieve fields for | ||||||
| ext-key | External key that uniquely identifies the account to retrieve fields for | ||||||
| ext-type | Type of external key | |||||||
| form-id | Numeric value that identifies the form | |||||||
Request body: | None | |||||||
Response body: | Returns a JSON array of fields, containing fieldID, description, type, and if the field is a multichoice type, the field will contain an options array of options containing optionID and description.
Example [
{
"fieldID": 87,
"type": "Text",
"description": "Description of this text field"
},
{
"fieldID": 88,
"type": "Singlechoice",
"description": "Description of this single choice field",
"options": [
{
"optionID": 134,
"description": "Yes"
},
{
"optionID": 135,
"description": "No"
}
]
},
{
"fieldID": 89,
"type": "Multichoice",
"description": "Description of this multi-choice field",
"options": [
{
"optionID": 136,
"description": "red"
},
{
"optionID": 137,
"description": "blue"
},
{
"optionID": 138,
"description": "green"
}
]
}
]
| |||||||
Status codes: | 200 | Form fields successfully retrieved | ||||||
| 404 | Form or account not found. The following sub codes may be returned:
| |||||||