Sprievodca - API

Dotazníky

Zoznam operácií pre zdroj

Názov URL Popis
Zoznam dotazníkov /surveys
Vracia zoznam všetkých dotazníkov prihláseného užívateľa. Dotazníky sú radené podľa dátumu vo vzostupnom poradí.
Vyhľadávanie dotazníkov /surveys/search Vracia zoznam všetkých dotazníkov, ktorý zodpovedá kritériám vyhľadávania. Dotazníky sú radené podľa dátumu vo vzostupnom poradí.
Informácie dotazníka /surveys/:id Detailné informácie o dotazníku. Narozdiel od údajov z predchádzajúcej operácie, tu budú vrátená dáta o doméne, vzhľade a základné informácie o otázkach, rozdelená do stránok.
Aktivácia dotazníka /surveys/activate/:id Začiatok zberu výsledkov dotazníka
Deaktivácia dotazníka /surveys/deactivate/:id Ukončenie zberu výsledkov dotazníka.
Status dotazníka bude nastavený na Vytvorenie dotazníka (1) alebo Analýza výsledkov (3), v závislosti na nazbieraných výsledkoch.

Popis parametrov odpovede

Názov/cesta Popis Možné hodnoty
id Survey ID
title Názov dotazníka
url_title Názov dotazníka použitý v „clean url“ odkazoch
date_created Dátum vytvorenia dotazníka
date_published Dátum prvej publikácia dotazníka – začiatok zberu výsledkov null – Ak nebol dotazník publikovaný
$ Data – Ak bol dotazník publikovaný
date_modified Dátum poslednej úpravy dotazníka null – Ak nebol dotazník upravovaný
$ Data – Ak bol dotazník upravovaný
date_end Dátum prvého ukončenia zberu výsledkov null – Ak nebol dotazník ukončený
$ Data – Ak bol dotazník ukončený
answers_count Počet vyplnenie dotazníka
status Status dotazníka 0 – Vytváranie dotazníka
1 – Zbieranie výsledkov
2 – Analýza výsledkov
type Typ dotazníka 0 – Dotazník
1 – Test
personal_data Dotazník zbiera osobné údaje 0 – Áno
1 – Nie
lang_code Jazyk rozhrania dotazníka sk – Český
sk – Slovenčina
en – Anglický
de – Nemecký
security_level Úroveň ochrany 1 – Stredná – Dotazník je dostupný len prostredníctvom priameho odkazu.

2 – Vysoká – Dotazník je dostupný len po zadaní hesla. Heslo je rovnaké pre všetkých.

3 – Najvyššia – Dotazník je chránený heslom (tokenom) na jedno použitie. Tu platí jeden token na respondenta / používateľa.

anonymous
Identifikácia respondenta 0 – Zapnuté – vyplnenie môžete prepojiť s respondentom.
1 – Vypnuté – tokeny nedovolí identifikáciu respondenta. Jedná sa anonymný dotazník.
password Status == 2 Heslo pre prístup do dotazníka. Nastavené iba ak Status == 2
public_results Výsledky dotazníka 0 – nie sú verejne dostupné

1 – sú verejné dostupné

many_answers_from_cookie Vyplnenie dotazníka 0 – Len raz z jedného počítača

1 – Ľubovoľný počet vyplnenie z rovnakého počítača

email_notification Zaslať e-mailovú správu s informáciou o vyplnenie 0 – Vypnuté
1 – Zapnuté
comments
Respondenti môžu komentovať dotazník 0 – Vypnuté
1 – Zapnuté
social_media Respondenti môžu umiestniť odkaz na dotazník na rôzne sociálne siete 0 – Vypnuté
1 – Zapnuté
contact_with_author_form Zobraziť tlačidlo umožňujúce používateľom kontaktovať autora dotazníka 0 – Vypnuté
1 – Zapnuté
progress_bar Zobraziť ukazovateľ priebehu vyplnenie dotazníka 0 – Vypnuté
1 – Zapnuté
partial_answers Možnosť odložiť vyplnenie dotazníka na neskôr 0 – Vypnuté
1 – Zapnuté
reversible Zobraziť tlačidlo Späť v dotazníkoch s viac ako jednou stránkou 0 – Vypnuté
1 – Zapnuté
answers_limit Automatické ukončenie dotazníka po dosiahnutí limitu počtu respondentov
autostart_date Automatické spustenie dotazníka vo vybraný deň
expiration_date Automatické ukončenie dotazníka vo vybraný deň
search_engines Indexovanie dotazníka web topánky 0 – Vypnuté
1 – Zapnuté
action_after_answer Akcia po vyplnení 0 – Zobraziť ďakovacej stránku
1 – Späť na začiatok dotazníka
2 – Presmerovať na externé adresu
redirection Adresa stránky, na ktorú bude presmerovaný po vyplnení dotazníka pokiaľ action_after_answer == 2action_after_answer == 2
thank_you_text
‚Ďakovacej‘ správa zobrazená po vyplnení dotazníka
pages.questions.type Typ otázky 0 – Otázka s jednou možnosťou výberu
1 – Maticová otázka s jednou možnosťou výberu
2 – Popis
4 – Formulár
5 – rankingové otázka
6 – Otázka s viacerými možnosťami výberu
7 – Maticová otázka s viacerými možnosťami výberu
8 – Otázka s posuvníkom (stupnice)
9 – Otvorená otázka
10 – Numerická otázka
11 – Otázka na e-mailovú adresu
12 – Dátumová otázka
13 – Roletka
14 – Úrad pre ochranu osobných údajov (Klauzula)
15 – Vloženie súboru
16 – NPS
17 – Otvorená maticová otázka
19 – Otázka uchopiť a presunúť

Zoznam dotazníkov

URL

(GET) https://www.netquest.sk/api/surveys

Parametre (POST)

Názov Popis
limit Limit počtu dotazníkov
offset Offset v zozname

Ukážka odpovede

[
  {
    "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

Žiadne

Vyhľadávanie dotazníka

URL

(GET) https://www.netquest.sk/api/surveys/search

Parametre (POST)

Názov Popis
title Názov dotazníka
date_created Dátum vytvorenia dotazníka. Dátum musí byť poskytnuté vo formáte YYYY-MM-DD (napr. 2011-11-20). Po zadaní parametra budú vrátené všetky dotazníky vytvorené v daný deň.
date_published Dátum Vytvorením dotazníka. Dátum musí byť poskytnuté vo formáte YYYY-MM-DD (napr. 2011-11-20). Po zadaní parametra budem vrátené Všetky dotazníky vytvorené v daný deň.
date_end Dátum prvého ukončenia zberu výsledkov. Dátum musí byť poskytnuté vo formáte YYYY-MM-DD (napr. 2011-11-20). Po zadaní parametra budú vrátené všetky dotazníky ukončenej v daný deň.
status Status dotazníka. Povolené hodnoty sú: 0, 1 a 2
type Typ dotazníka. Povolené hodnoty sú: 0 – dotazník, 1 – test a 2 –
widget
security_level Úroveň zabezpečenia dotazníka. Povolené hodnoty sú: 1, 2, 3
limit Limit počtu dotazníkov
offset Offset v zozname

Ukážka odpovede

{
    "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 Nenájdené – Chybný formát dátumu, chybný status alebo chybná úroveň zabezpečenia.
    500 Interná chyba servera – Interná chyba servera.

Informácia dotazníka

URL

(GET) https://www.netquest.sk/api/surveys/:id

Parametre

Žiadne

Ukážka odpovede

{
    "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.sk",
		"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.sk\/user_files\/user_logo\/16552\/netquestcz.png"
	}
}

Chybové hlášky

  • 404 Nenájdené – Zdroj nebol nájdený alebo neexistuje.

Aktivácia dotazníka

URL

(GET) https://www.netquest.sk/api/surveys/activate/:id

Parametre

Žiadne

Ukážka odpovede

{
  "status":2
}

Deaktivácia dotazníka

  • 404 Nenalezeno – Zdroj nebyl nalezen nebo neexistuje.
  • 409 Konflikt – Selhala změna statusu dotazníku.
  • 500 Interní chyba serveru – Interní chyba serveru.

Deaktivácia dotazníka

URL

(GET) https://www.netquest.sk/api/surveys/deactivate/:id

Parametre

Žádné

Ukážka odpovede

{
  "status":2
}

Chybové hlášky

  • 404 Nenájdené – Zdroj nebol nájdený alebo neexistuje.

Pomohol Vám tento článok?

Ďakujeme za odpoveď