Webanketa API

Object

{ "api_ssessid": "[session_id]" }

Object

{ "error": "[error_message]" }

api.ssessid = [session_id]

Object

{ "result": true }

Object

{ "result": false }

api.ssessid = [session_id] lang.uid = [lang_uid]

Object

{ "uid": "1", "name": "English", "code": "en", // used in URL "rtl": "0" // right-to-left }

Object

{ "error": "[error_message]" }

api.ssessid = [session_id]

Array

[ Object

{ "uid": "69385", "default_lid": "9", "create_date": "2014-05-10", // date in format: yyyy-mm-dd "create_time": "16:30:49", // time in format: HH:mm:ss "create_time_dst": "1", // Daylight Saving Time "update_date": "2014-05-10", "update_time": "17:16:21", "update_time_dst": "1", "status": "1", "name": "lang bug fix", "_answer_periods": Array

[ Object

{ "period_uid": "68554", "begin_answer": "0", "end_answer": "0", "limit_answers": "0", "status": "0" }

]

Object

{ "uid": "69384", "default_lid": "9", "create_date": "2014-03-15", // date in format: yyyy-mm-dd "create_time": "17:08:19", // time in format: HH:mm:ss "create_time_dst": "0", // Daylight Saving Time "update_date": "2014-09-27", "update_time": "18:21:57", "update_time_dst": "1", "status": "1", "name": "answer_limits", "_answer_periods": Array

[ Object

{ "period_uid": "68553", "begin_answer": "0", "end_answer": "0", "limit_answers": "0", "status": "0" }

]

}

]

Object

{ "error": "[error_message]" }

api.ssessid = [session_id] form.uid = [form_uid]

Object

{ "uid": "2600", "default_lid": "9", "create_date": "2010-05-08", // date in format: yyyy-mm-dd "create_time": "19:30:58", // time in format: HH:mm:ss "create_time_dst": "1", // Daylight Saving Time "update_date": "2014-08-09", "update_time": "18:22:22", "update_time_dst": "1", "status": "1", "name": "all components", "_active_answer_period": Object // period of collecting answers

{ "period_uid": "1773", "start_date": "2010-05-08", "start_time": "16:32:07", "end_date": "2023-10-26", "end_time": "16:53:29", "begin_answer": "22", "end_answer": "20" }

}

Object

{ "error": "[error_message]" }

api.ssessid = [session_id] form.uid = [form_uid]

Array

[ Object

{ "lang_code": "", // code of language (if empty string => language selector page for multilingual form) "active": true, // translation was finished "title": "Sample form title", // title of form "url": "http://webanketa.com/forms/zzt3cd1j5xk64rhn6gv38zz/", // address of form "embed_html": "<script type="text/javascript">var WebAnketaParams = ["zzt3cd1j5xk64rhn6gv38zz", "Sample form title"]; document.write(unescape("<"+"script src='http"+(/^https:\/\//.test(document.URL) ? "s" : "")+"://webanketa.com/direct/js/embed.js' type='text/javascript'><"+"/script>")); </script><noscript><a href="http://webanketa.com/forms/zzt3cd1j5xk64rhn6gv38zz/" target="_blank">Sample form title</a></noscript>" // HTML for embed form },

Object

{ "lang_code": "ru", "active": true, "title": "Sample form title", "url": "http://webanketa.com/forms/zzt3cd1j5xk64rhn6gv38zz/ru/", "embed_html": "<script type="text/javascript">var WebAnketaParams = ["zzt3cd1j5xk64rhn6gv38zz/ru", "Sample form title"]; document.write(unescape("<"+"script src='http"+(/^https:\/\//.test(document.URL) ? "s" : "")+"://webanketa.com/direct/js/embed.js' type='text/javascript'><"+"/script>")); </script><noscript><a href="http://webanketa.com/forms/zzt3cd1j5xk64rhn6gv38zz/ru/" target="_blank">Sample form title</a></noscript>" }

]

Object

{ "error": "[error_message]" }

api.ssessid = [session_id] form.uid = [form_uid]

Object

[ Object {...} ],

"_active_answer_period": 0, "_languages": Array

[ Object {...} Object {...} Object {...} ],

"_components": Array

[ Object {...} Object {...} ]

}

Object

{ "error": "[error_message]" }

api.ssessid = [session_id] form.uid = [form_uid] start_answer_uid = [answer_uid][-] // not required

Array

[ Object

{ "uid": "31939", "answer_nr": "1", "ip2long": "1310507274", "duration": "0", "create_date": "2010-05-08", "create_time": "16:33:36", "create_time_dst": "1", "read": "1", // read the owner form "lang_name": "Русский", "form_args": "" },

Object

{ "uid": "152441", "answer_nr": "2", "ip2long": "2130706433", "duration": "0", "create_date": "2012-04-14", "create_time": "18:45:16", "create_time_dst": "1", "read": "1", // read the owner form "lang_name": "Русский", "form_args": "" }

]

Object

{ "error": "[error_message]" }

api.ssessid = [session_id] form.uid = [form_uid] answer.uid = [answer_uid]

Object

{ "uid": "31939", "respondent_uid": "31945", "respondent_lid": "9", "answer_period_uid": "1773", "answer_nr": "1", "finished_answer": "1", "duration": "0", "ip2long": "1310507274", "country": "LV", "read": "1", "create_date": "2010-05-08", "create_time": "16:33:36", "create_time_dst": "1", "update_date": "2010-05-08", "update_time": "16:33:36", "update_time_dst": "1", "form_args": "", "http_referer": "", "http_user_agent": "Opera/9.80 (Windows NT 6.1; U; en) Presto/2.5.24 Version/10.54", "_question_answers": Array

[ Object {...} Object {...} Object {...} Object {...} Object {...} ]

}

Object

{ "error": "[error_message]" }

api.ssessid = [session_id] form.uid = [form_uid] http_referer = [http_referer] // not required form.lang = [form_lang] // not required form.page = [form_page_nr] // not required form.args = [form_args] // not required respondent.ip = [ip address] // not required respondent.cuid = [32bit uniq number per respondent] // not required respondent.sessid = [respondent sessid] // not required answer.uid = [answer_uid] // not required ctrl[id1][id2][id3] = [value] ctrl[id4][id5][id6] = [value] ctrl[id7][id7][id8] = [value]

Object

{ "answer_uid": 12345, "finished": 1, "respondent_cuid": "[respondent cookie id]", "respondent_sessid": "[respondent sess id]", "form_errors": Object {...} }

Object

{ "error_code": "[error code]", "error_msg": "[error message]" }

api.ssessid = [session_id] form.uid = [form_uid] ctrl.id = [control_uid] // only, if need list of one control answers pg = [page_number] // page number for list of one control answers

Array

[ Object {...}

{ "component_uid": "11427", "component_type": "string", "question": "строковое поле", "partial_output": 1, "control_uid": "38177", "respondents_total": "22", "non_respondents_total": 0, "answers": Array

[ Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} ]

Object {...}

{ "component_uid": "341281", "component_type": "radiobuttons", "question": "один из множества", "partial_output": null, "control_uid": null, "respondents_total": 18, "non_respondents_total": 4, "answers": Array

[ Object {...} Object {...} Object {...} ]

Object {...}

{ "component_uid": "11433", "component_type": "table", "question": "таблица", "partial_output": null, "control_uid": null, "respondents_total": "20", "non_respondents_total": 2, "answers": Array

[ Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} ]

Object {...} Object {...}

{ "component_uid": "341283", "component_type": "number", "question": "целое число", "partial_output": 1, "control_uid": "1626103", "respondents_total": "16", "non_respondents_total": 6, "answers": Array

[ Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} ]

}

]

Object

{ "component_uid": "341283", "question": "целое число", "control_uid": 1626103, "respondents_total": "22", "offset": 0, "answers": Array

[ Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} Object {...} ]

}

Object

{ "error": "[error_message]" }

api.ssessid = [session_id] form.uid = [form_uid] answer.uid = 1772766 // or uid of answer answer.uids = 1772766,1772767 // or list of uids, separated by comma

Object

{ "result": "ok" }

Object

{ "error": "[message]" }

api.ssessid = [session_id] form.uid = [form_uid] component[197637][disabled] = 1 // disable component

Object

{ "result": "ok" }

Object

{ "error": "[message]" }

api.ssessid = [session_id] form.uid = [form_uid]

Object

{ "result": "ok" }

Object

{ "error": "[message]" }

api.ssessid = [session_id] form.uid = [form_uid]

Object

{ "result": "ok" }

Object

{ "error": "[message]" }

Summary

input:

output sample:

error {}:

input:

output sample:

error:

input:

output sample:

error:

input:

output sample:

error:

input:

output sample:

error:

input:

output sample:

error:

input:

output sample:

error:

input:

output sample:

error:

input:

output sample:

error:

input:

output sample:

error:

input:

output sample:

error:

input:

output sample:

error:

input:

output sample:

error:

input:

output sample:

error:

input:

output sample:

error: