Seznam operací pro zdroj
Název | URL | Popis |
---|---|---|
Seznam dotazníků | /surveys |
Vrací seznam všech dotazníků přihlášeného uživatele. Dotazníky jsou řazeny podle data ve vzestupném pořadí. |
Vyhledávání dotazníků | /surveys/search |
Vrací seznam všech dotazníků, který odpovídá kriteriím vyhledávání. Dotazníky jsou řazeny podle data ve vzestupném pořadí. |
Informace dotazníku | /surveys/:id |
Detailní informace o dotazníku. Narozdíl od údajů z předchozí operace, zde budou vrácená data o doméně, vzhledu a základní informace o otázkách, rozdělena do stránek. |
Aktivace dotazníku | /surveys/activate/:id |
Začátek sběru výsledků dotazníku |
Deaktivace dotazníku | /surveys/deactivate/:id |
Ukončení sběru výsledků dotazníku. Status dotazníku bude nastaven na Vytvoření dotazníku ( 1 ) nebo Analýza výsledků (3 ), v závislosti na nasbíraných výsledcích. |
Popis parametrů odpovědi
Název/cesta | Popis | Možné hodnoty |
---|---|---|
id |
Survey ID | |
title |
Název dotazníku | |
url_title |
Název dotazníku použitý v „clean url“ odkazech | |
date_created |
Datum vytvoření dotazníku | |
date_published |
Datum první publikace dotazníku – začátek sběru výsledků | null – Nebyl-li dotazník publikován$data – Byl-li dotazník publikován |
date_modified |
Datum poslední úpravy dotazníku | null – Nebyl-li dotazník upravován$data – Byl-li dotazník upravován |
date_end |
Datum prvního ukončení sběru výsledků | null – Nebyl-li dotazník ukončen$data – Byl-li dotazník ukončen |
answers_count |
Počet vyplnění dotazníku | |
status |
Status dotazníku | 0 – Vytváření dotazníku1 – Sbírání výsledků2 – Analýza výsledků |
type |
Typ dotazníku | 0 – Dotazník1 – Test |
personal_data |
Dotazník sbírá osobní data | 0 – Ano1 – Ne |
lang_code |
Jazyk rozhraní dotazníku | cs – Českýsk – Slovenskýen – Anglickýde – Německý |
security_level |
Úroveň ochrany | 1 – Střední – Dotazník je dostupný pouze prostřednictvím přímého odkazu.
|
anonymous |
Identifikace respondenta | 0 – Zapnuto – vyplnění můžete propojit s respondentem.1 – Vypnuto – tokeny nedovolí identifikaci respondenta. Jedná se anonymní dotazník. |
password |
Heslo pro přístup do dotazníku. Nastavené pouze pokud Status == 2 |
|
public_results |
Výsledky dotazníku | 0 – Nejsou věřejně dostupné
|
many_answers_from_cookie |
Vyplnění dotazníku | 0 – Pouze jednou z jednoho počítače
|
email_notification |
Zaslat e-mailovou zprávu s oznamením o vyplnění | 0 – Vypnuto1 – Zapnuto |
comments |
Respondenti mohou komentovat dotazník | 0 – Vypnuto1 – Zapnuto |
social_media |
Respondenti mohou umístit odkaz na dotazník na různé sociální sítě | 0 – Vypnuto1 – Zapnuto |
contact_with_author_form |
Zobrazit tlačítko umožňující uživatelům kontaktovat autora dotazníku | 0 – Vypnuto1 – Zapnuto |
question_numbers |
Zobrazit počet otázek | 0 – Vypnuto1 – Zapnuto |
progress_bar |
Zobrazit ukazatel průběhu vyplnění dotazníku | 0 – Vypnuto1 – Zapnuto |
partial_answers |
Možnost odložit vyplnění dotazníku na později | 0 – Vypnuto1 – Zapnuto |
reversible |
Zobrazit tlačítko Zpět v dotaznících s více než jednou stránkou | 0 – Vypnuto1 – Zapnuto |
answers_limit |
Automatické ukončení dotazníku po dosažení limitu počtu respondentů | |
autostart_date |
Automatické spuštění dotazníku ve vybraný den | |
expiration_date |
Automatické ukončení dotazníku ve vybraný den | |
search_engines |
Indexování dotazníku web boty | 0 – Vypnuto1 – Zapnuto |
action_after_answer |
Akce po vyplnění | 0 – Zobrazit děkovací stránku1 – Zpět na začátek dotazníku2 – Přesměrovat na externí adresu |
redirection |
Adresa stránky, na kterou bude přesměrován po vyplnění dotazníku pokud action_after_answer == 2 |
|
thank_you_text |
‚Děkovací‘ zpráva zobrazená po vyplnění dotazníku | |
pages.questions.type |
Typ otázky | 0 – Otázka s jednou možností výběru1 – Maticová otázka s jednou možností výběru2 – Popis4 – Formulář5 – Rankingová otázka6 – Otázka s více možnostmi výběru7 – Maticová otázka s více možnostmi výběru8 – Otázka s posuvníkem (stupnice)9 – Otevřená otázka10 – Numerická otázka11 – Otázka na e-mailovou adresu12 – Datumová otázka13 – Roletka14 – Úřad pro ochranu osobních údajů (Klauzule)15 – Vložení souboru16 – NPS17 – Otevřená maticová otázka19 – Otázka uchopit a přesunout |
Seznam dotazníků
URL
(GET) https://www.netquest.cz/api/surveys
Parametry (POST)
Název | Popis |
---|---|
limit |
Limit počtu dotazníků |
offset |
Offset v seznamu |
Ukázka odpovědi
[ { "id":69047, "title":"Můj testovací dotazník", "url_title":"muj-testovaci-dotaznik", "date_created":"2011-09-19 13:22:06", "date_published":"2011-09-19 13:23:10", "date_modified":"2011-09-19 13:23:10", "date_end":null, "answers_count":0, "status":1, "type":0, "personal_data":0, "lang_code":"cs", "security_level":0, "anonymous":0, "password":"", "public_results":1, "many_answers_from_cookie":1, "email_notification":0, "comments":1, "social_media":1, "contact_with_author_form":1, "question_numbers":1, "progress_bar":0, "partial_answers":0, "reversible":0, "answers_limit":0, "expiration_date":null, "search_engines":1, "action_after_answer":0, "redirection":null, "thank_you_text":"Děkujeme za vyplnění dotazníku" }, { ... } ]
Chybové hlášky
Žádné
Vyhledávání dotazníku
URL
(GET) https://www.netquest.cz/api/surveys/search
Parametry (POST)
Název | Popis | |
---|---|---|
title |
Název dotazníku | |
date_created |
Datum vytvoření dotazníku. Datum musí být poskytnuté ve formátu YYYY-MM-DD (např. 2011-11-20). Po zadání parametru budou vráceny všechny dotazníky vytvořené v daný den. | |
date_published |
Datum první publikace dotazníku. Datum musí být poskytnuté ve formátu YYYY-MM-DD (např. 2011-11-20). Po zadání parametru budou vráceny všechny dotazníky publikované v daný den. | |
date_end |
Datum prvního ukončení sběru výsledků. Datum musí být poskytnuté ve formátu YYYY-MM-DD (např. 2011-11-20). Po zadání parametru budou vráceny všechny dotazníky ukončené v daný den. | |
status |
Status dotazníku. Povolené hodnoty jsou: 0, 1 a 2 | |
type |
Typ dotazníku. Povolené hodnoty jsou: 0 – dotazník, 1 – test a 2 – widget |
|
security_level |
Úroveň zabezpečení dotazníku. Povolené hodnoty jsou: 1, 2, 3 | |
limit |
Limit počtu dotazníků | |
offset |
Offset v seznamu |
Ukázka odpovědi
{ "id":69047, "title":"Můj testovací dotazník", "url_title":"muj-testovaci-dotaznik", "date_created":"2011-09-19 13:22:06", "date_published":"2011-09-19 13:23:10", "date_modified":"2011-09-19 13:23:10", "date_end":null, "answers_count":0, "status":1, "type":0, "personal_data":0, "lang_code":"cs", "security_level":0, "anonymous":0, "password":"", "public_results":1, "many_answers_from_cookie":1, "email_notification":0, "comments":1, "social_media":1, "contact_with_author_form":1, "question_numbers":1, "progress_bar":0, "partial_answers":0, "reversible":0, "answers_limit":0, "expiration_date":null, "search_engines":1, "action_after_answer":0, "redirection":null, "thank_you_text":"Děkujeme za vyplnění dotazníku" }, { ... } ]
Chybové hlášky
404 Nenalezeno
– Chybný formát datumu, chybný status nebo chybná úroveň zabezpečení.500 Interní chyba serveru
– Interní chyba serveru.
Informace dotazníku
URL
(GET) https://www.netquest.cz/api/surveys/:id
Parametry
Žádné
Ukázka odpovědi
{ "id":69047, "title":"Můj testovací dotazník", "url_title":"muj-testovaci-dotaznik", "date_created":"2011-09-19 13:22:06", "date_published":"2011-09-19 13:23:10", "date_modified":"2011-09-19 13:23:10", "date_end":null, "answers_count":0, "status":1, "type":0, "personal_data":0, "lang_code":"cs", "security_level":0, "anonymous":0, "password":"", "public_results":1, "many_answers_from_cookie":1, "email_notification":0, "comments":1, "social_media":1, "contact_with_author_form":1, "question_numbers":1, "progress_bar":0, "partial_answers":0, "reversible":0, "answers_limit":0, "expiration_date":null, "search_engines":1, "action_after_answer":0, "redirection":null, "thank_you_text":"Děkujeme za vyplnění dotazníku" "domain":{ "type":"subdomain", "main":false, "address":"dotaznik.mojefirma.cz" }, "pages":[{ "id":261181, "number":1, "questions":[{ "id":804039, "type":9, "order":1, "number":0, "text":"Popisový blok", "desc":"Vítejte!", "date_created":"2011-05-06 00:39:14" }, { ... }] },{ "id":261182, "number":2, "questions":[{ "id":804041, "type":0, "order":1, "number":1, "text":"Jak jste se dozvěděli o našem dotazníku?", "desc":"", "date_created":"2011-06-27 16:29:50" },{ ... }] }], "skin":{ "id":"115", "name":"Netquest.cz", "head_background":"ffffff", "progress_bar_background":"93341E", "title_color":"93341E", "title_border":"eeeeee", "question_color":"93341E", "button_color":"ffffff", "button_background":"93341E", "logo":"http:\/\/www.netquest.cz\/user_files\/user_logo\/16552\/netquestcz.png" } }
Chybové hlášky
404 Nenalezeno
– Zdroj nebyl nalezen nebo neexistuje.
Aktivace dotazníku
URL
(GET) https://www.netquest.cz/api/surveys/activate/:id
Parametry
Žádné
Ukázka odpovědi
{ "status":2 }
Chybové hlášky
404 Nenalezeno
– Zdroj nebyl nalezen nebo neexistuje.409 Konflikt
– Selhala změna statusu dotazníku.500 Interní chyba serveru
– Interní chyba serveru.
Deaktivace dotazníku
URL
(GET) https://www.netquest.cz/api/surveys/deactivate/:id
Parametry
Žádné
Ukázka odpovědi
{ "status":2 }
Chybové hlášky
404 Nenalezeno
– Zdroj nebyl nalezen nebo neexistuje.