Dataset: Questions and Answers

Dataset name: ds_questions_answers

Description

Question & Answer Data Record

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Answer Question Version	answer_question_version	The version of the question this answer was made against.	int	What is your favourite colour?
Answer Result	answer_result	JSON obejct of the structured answer result.	blob	{colour: blue}
Answer Timestamp	answer_timestamp	Timestamp of when answer was made.	varchar	1638375529
Answer Version History	answer_version_history	JSON BLOB, contains the question version, content, change description.	blob	"{"question_version" : "What is your favourite colour?", "content" : "blue, red, pink, yellow", "description" : "Blue."}"
Answer Version Id	answer_version_id	The Version ID of this question. Not Null.	varchar	12
Connection ID	con_id	The organisation that asked this question.	varchar	Glasgow Phones
Group ID	group_id	The group ID that this question belongs to.	blob	"{"group_id" : "1"}"
Questions and Answers ID	id	The primary identifier for this record.	serial	6
Questions and Answers Instance	instance	The instance this item relates to.	int	2
Question ID	question_id	The identifier for a question-answer.	varchar	5
Question Label	question_label	The main question label text of the queston.	varchar	Favourite Colour
Question Set Format	question_set_format	JSON BLOB, contains the format of the question set.	blob	"{"questions format" : "questions"}"
Question Tags	question_tags	Tags of associated with this question, comma seperated.	varchar	Preferences, Interests, Likes
Question Timestamp	question_timestamp	The timestamp of when this question was created.	varchar	1638375529
Question Version History	question_version_history	JSON BLOB, contains the question version, content, change description.	blob	"{"question_version" : "What is your favourite colour?", "content" : "blue, red, pink, yellow", , "descriptio\" : "The preferred colour of the user."}"
Question Version Id	question_version_id	The Version ID of this question. Not Null.	varchar	7
Question Modified Timestamp	queston_modified_timestamp	The timestamp of when this question was last modified.	varchar	1639153129
Questions and Answers Source	source	The source of the data - user or connection.	varchar

---

Making an API request for this Dataset

Example Request to the Sandbox Server

http://sbx-api.mydex.org/api/pds/transaction/UID.json
  ?key=KEY
  &api_key=API_KEY
  &con_id=CON_ID
  &source_type=connection
  &dataset=ds_questions_answers
  &instance=N

Replace the following with your own details: UID KEY, API_KEY, CON_ID and instance N.

Replace sbx-api with api when making a connection to a real member on the production server (must be authenticated).

To return the data in XML, change UID.json to UID.xml.

Example Response

A response to this API request will be structured as follows.

{
  "6": {
    "id": "6",
    "ds_id": "6",
    "answer_question_version": "What is your favourite colour?",
    "answer_result": "{colour: blue}",
    "answer_timestamp": "1638375529",
    "answer_version_history": "\"{\"question_version\" : \"What is your favourite colour?\", \"content\" : \"blue, red, pink, yellow\", \"description\" : \"Blue.\"}\"",
    "answer_version_id": "12",
    "con_id": "Glasgow Phones",
    "group_id": "\"{\"group_id\" : \"1\"}\"",
    "question_id": "5",
    "question_label": "Favourite Colour",
    "question_set_format": "\"{\"questions format\" : \"questions\"}\"",
    "question_tags": "Preferences, Interests, Likes",
    "question_timestamp": "1638375529",
    "question_version_history": "\"{\"question_version\" : \"What is your favourite colour?\", \"content\" : \"blue, red, pink, yellow\", , \"descriptio\\\" : \"The preferred colour of the user.\"}\"",
    "question_version_id": "7",
    "queston_modified_timestamp": "1639153129"
  }
}