Průvodce - API

Vyplnění dotazníku

Seznam operací pro zdroj

Název URL Popis
Začátek vyplňování /responses/getaccess
/:id_survey
Před zodpovězením nějaké otázky, je zapotřebí získat přístup k dotazníku.
Toto je nezbytné, vyžaduje-li dotazník heslo, jednorázové heslo, nebo má-li omezenou platnost.
Je-li respondentovi dotazník dostupný, vrátí klíč na jedno použití, který identifikuje respondenta při vyplňování následujících stránek a otázek.
Odpovídání otázek /responses/answer
/:id_survey/:id_response
Tato operace je použita pro všechny otázky v rozsahu stránky.
Vhodně postavené POST parametry by měly být zaslány v rámci této adresy – vhodné konstrukce pro všechny typy otázek.
Jsou-li odpovědi správné, systém vrátí ID stránky, která má být vyplněna jako další.
Výsledkem je přechod mezi stránkami podle dané odpovědi.
Určení doby vyplnění /responses/settime
/:id_survey/:id_response
Je-li dotazník vyplněn na offline mobilním zaařízení, není možné pro API správně spočítat čas vyplnění. Z tohoto důvodu zde musí být operace, která umožní nastavení počátečního a ukončujícího času datumu vyplnění.

Popis parametrů odpovědi

Název/cesta Popis Možné hodnoty
id_response ID vyplnění použité pro vyplnění více stránkových dotazníků.
Použité společně s parametrem respondent_key
respondent_key Klíč identifikující vyplnění a respondenta
Použitím tohoto parametru systém ověří přístup do dotazníku a správné pořadí vyplnění stránky.
id_next_page ID stránky, která má být vyplněna jako další
acknowledgments Obsah ‚děkovací‘ stránky
verification_code Potvrzující kód, který je vrácen v případě, že možnost „Generovat unikátní kód po vyplnění dotazníku“ byla v dotazníku zapnuta
error_code Kód odpovědi, pokud přístup do dotazníku selhal 1 – Neaktivní studie
2 – Ukončená studie
3 – Nesprávná hodnota parametru url_title
4 – Nesprávná hodnota parametru password
5 – Nesprávná hodnota parametru token
6 – Token je již použit
7 – Nesprávný klíč respondenta (:respondent_key)
8 – Nebyly vyplněny všechny povinné otázky
9 – Nesprávný typ otázky
10 – Nesprávné pořadí dávání odpovědí. Nesprávná hodnota parametru id_page
11 – Respondent ukončil vyplňování dotazníku

Začátek vyplňování

URL

(POST) https://www.netquest.cz/api/responses/getaccess

Parametry (GET)

Název Popis
id_survey ID dotazníku. Povinný parametr

Parametry (POST)

Název Popis
url_title Parametr vyžadovaný v dotaznících se střední úrovní ochrany.
Hodnota parametru je název dotazníku v podobě odkazu dotazníku.
Parametr url_title je vrácen v operaci Informace o dotazníku
password Parametr vyžadovaný v dotaznících s vysokou úrovní ochrany.
Přístup do dotazníku vyžaduje heslo.
Heslo je stejné pro všechny respondenty.
token Parametr vyžadovaný v dotaznících se nejvyšší úrovní ochrany.
Přístup k dotazníku vyžaduje token.
Token je heslo na jednorázovou použití, identifikující respondenta.

Ukázka odpovědi

{
	"id_next_page":269666,
	"id_response":5902271,
	"respondent_key":"78a37f13bf9afc471151994a4f47f29a"
}

Errors

  • 404 Nenalezeno – Dotazník neexistuje.
  • 406 Nepřijatelné – Povinné parametry nebyly předány.
  • 500 Interní chyba serveru – Interní chyba serveru.

Odpovídání otázek

URL

(GET) https://www.netquest.cz/api/responses/answer

Parametry (GET)

Název Popis
id_survey ID dotazníku. Povinný parametr
id_response ID vyplnění. Povinný parametr
ID je vráceno v operaci /responses/getaccess

Parametry (POST)

POST parametry se liší v závislosti na typu zodpovězených dotazů.
Níže uvedené POST parametry se liší v závislosti na typu převáděného otázky

Název Popis
respondent_key Potvrzující kód respondenta. Klíč je vrácen operací /responses/getaccess
id_page ID stránky vyplněné respondentem
questions[:id_question][type] Typ otázky, odeslán jako celé číslo. Dostupné hodnoty jsou: 0 až 13

Otázka s jednou možností výběru

Název Hodnota Popis
questions[:id_question][type] 0 Hodnota parametru pro otázku s jednou možností výběru
questions[:id_question][answer] :answer_number Číslo odpovědi. Odpovědi jsou očíslovány od 1 do 60
questions[:id_question][other_answer][:answer_number] string Odpověď poskytnutá respondentem v textovém poli.
Tento parametr je odeslán pro odpovědi, ve kterých respondent může zadat svou vlastní odpověď.

Otázka s více možnostmi výběru

Název Hodnota Popis
questions[:id_question][type] 6 Hodnota parametru pro otázku s více možnostmi výběru
questions[:id_question][answers][:answer_number] true Příznak označující, že odpověď s daným :answer_number byla vybrána respondentem
questions[:id_question][other_answers][:answer_number] string Vlastní odpověď respondenta. Tento parametr je odeslán pro odpovědi, ve kterých respondent může zadat vlastní odpověď.

Maticová otázka s jednou možností výběru

Název Hodnota Popis
questions[:id_question][type] 1 Hodnota parametru pro maticovou otázku s jednou možností výběru
questions[:id_question][answers][:answer_number] :scale_number V odpovědi číslo :answer_number (očíslované 1 až 60) respondent vybral možnost číslo :scale_number na stupnici (očíslované 1 až 15)

Maticová otázka s více možnostmi výběru

Název Hodnota Popis
questions[:id_question][type] 7 Hodnota parametru pro maticovou otázku s více možnostmi výběru
questions[:id_question][answers][:answer_number][:scale_number] true Příznak, označující, že v odpovědi číslo :answer_number (očíslované 1 až 60) respondent vybral pole v sloupci číslo :scale_number (očíslované 1 až 15)

Popisová otázka

Název Hodnota Popis
questions[:id_question][type] 2 Hodnota parametru pro popisovou otázku
questions[:id_question][answers][] string Popisová odpověď poskytnutá respondentem. Tabulka odpovědi má tolik elementů, kolik se nachází polí, do kterých lze zadat popisovou odpověď v otázce.

Přidělování bodů

Název Hodnota Popis
questions[:id_question][type] 3 Hodnota parametru pro otázku přidělování bodů
questions[:id_question][answers][:answer_number] :points_amount Odpovědi číslo :answer_number (očíslované 1 až 60) bylo přiděleno následující množství bodů: :points_amount

Rankingová otázka

Název Hodnota Popis
questions[:id_question][type] 5 Hodnota parametru pro rankingovou otázku
questions[:id_question][answers][:answer_number] :position_number Odpověď číslo :answer_number (očíslované 1 až 15) byla umístěna na pozici :position_number (očíslované 1 až 15)

Roletka

Název Hodnota Popis
questions[:id_question][type] 13 Hodnota parametru pro roletku
questions[:id_question][answer] :answer_number Respondent vybral odpověď na pozici :answer_number (očíslované 1 až 60) roletky

Formulář

Název Hodnota Popis
questions[:id_question][type] 4 Hodnota parametru pro formulář
questions[:id_question][answers][:answer_numer] string Respondent zadal svou odpověď jako text (string) do pole číslo :answer_numer (očíslované 1 až 60)

Otázka s posuvníkem (stupnice)

Název Hodnota Popis
questions[:id_question][type] 8 Value of the parameter for a slider question
questions[:id_question][answers][:answer_number] int_value V odpovědi (posuvník) číslo :answer_number (očíslované 1 až 15) nastavil respondent hodnotu int_value (přijímá hodnoty 1 až 100).

Otázka na číslo

Název Hodnota Popis
questions[:id_question][type] 10 Hodnota parametru pro otázku na číslo
questions[:id_question][answer] int_value Odpověď respondenta má hodnotu int_value

Otázka na e-mailovou adresu

Název Hodnota Popis
questions[:id_question][type] 11 Hodnota parametru pro otázku na číslo
questions[:id_question][answer] string Odpověď respondenta má hodnotu string

Otázka na datum

Název Hodnota Popis
questions[:id_question][type] 12 Hodnota parametru pro otázku na datum
questions[:id_question][answer] string Odpověď respondenta má hodnotu string ve formátu dd-mm-yyyy

Úřad pro ochranu osobních údajů

Název Hodnota Popis
questions[1][type] 14 Hodnota parametru pro klauzuli úřadu pro ochranu osobních údajů
questions[1][answer] true Příznak, určující, že respondent poskytl souhlas se zpracováním osobních údajů

Vložení souboru

Tento typ otázky není podporován v API

NPS

Název Hodnota Popis
questions[:id_question][type] 0 Hodnota parametru pro otázku NPS
questions[:id_question][answer] :answer_number Počet odpovědí na otázku. Odpovědi jsou číslovány od 1 do 11
questions[:id_question][other_answer][:answer_number] string Odpověď na otázku, kterou respondent uvedl jako odůvodnění výběru. Tento parametr je předán pro odpovědi, ve kterých je argumentování respondenta povoleno.

Otevřená maticová otázka

Název Hodnota Popis
questions[:id_question][type] 17 Hodnota parametru pro otevřenou maticovou otázku
questions[:id_question][answers][:answer_number][:scale_number] string Otevřená odpověď zadaná pro daný řádek a sloupec

Otázka uchopit a přesunout

Název Hodnota Popis
questions[:id_question][type] 1 Hodnota parametru pro otázku uchopit a přesunout
questions[:id_question][answers][:answer_number] :scale_number Odpovědi podle čísla: :answer_number (očíslované od 1 do 100) byly přiřazeny ke skupině čísel :scale_number (očíslované od 1 do 15)

Ukázka odpovědi

{
	"id_next_page":269666,
}	

Ukázka odpovědi II

{
	"acknowledgments":"Děkujeme za vyplnění dotazníku",
	"verification_code":"838882"
}

Chybové hlášky

  • 404 Nenalezeno – Dotazník neexistuje.
  • 406 Nepřijatelné – Povinné parametry nebyly předány.
  • 500 Interní chyba serveru – Interní chyba serveru.

Určení doby vyplnění

URL

(POST) https://www.netquest.cz/api/responses/settime

Parametry (GET)

Název Popis
id_survey ID dotazníku. Povinný parametr
id_response ID vyplnění. Povinný parametr. ID je vráceno operací /responses/getaccess

Parametry (POST)

Název Popis
respondent_key Ověřovací klíč respondenta. Klíč je vrácen operací /responses/getaccess
date_survey_open Povinný parametr. Datum a čas prvního otevření dotazníku. Formát data je: 2012-12-06 12:00:00
date_survey_answer Povinný parametr. Datum a čas vyplnění dotazníku. Formát data je: 2012-12-06 12:00:00

Ukázka odpovědi

{
	"confirmation":true
}

Errors

  • 404 Špatný požadavek – Nesprávný formát datumu.
  • 404 Nenalezeno – Dotazník neexistuje.
  • 406 Nepřijatelné – Povinné parametry nebyly předány.
  • 500 Interní chyba serveru – Interní chyba serveru.

Pomohl Vám tento článek?

Děkujeme za odpověď