Sprievodca - API

Vyplnenie dotazníka

Zoznam operácií pre zdroj

NázovURLPopis
Začiatok vypĺňania/responses/getaccess
/:id_survey
Pred zodpovedaním nejakej otázky, je potrebné získať prístup k dotazníku.
Toto je nevyhnutné najmä, ak dotazník vyžaduje heslo, jednorazové heslo, alebo ak má obmedzenú platnosť.
Ak je respondentovi dotazník dostupný, vráti kľúč na jedno použitie, ktorý identifikuje respondenta pri vypĺňaní nasledujúcich stránok a otázok.
Zodpovedanie otázok/responses/answer
/:id_survey/:id_response
Táto operácia je použitá pre všetky otázky v rozsahu stránky.
Vhodne postavené POST parametre by mali byť zaslané v rámci tejto adresy – vhodné konštrukcie pre všetky typy otázok.
Ak sú odpovede správne, systém vráti ID stránky, ktorá má byť vyplnená ako ďalšia.
Výsledkom je prechod medzi stránkami podľa danej odpovede.
Určenie doby vyplnenia/responses/settime
/:id_survey/:id_response
Ak je dotazník vyplnený na offline mobilnom zariadený, nie je možné pre API správne spočítať čas vyplnenia. Z tohto dôvodu tu musí byť operácia, ktorá umožní nastavenie počiatočného a konečného času dátumu vyplnenia.

Opis parametrov odpovede

Názov/cestaPopisMožné hodnoty
id_responseID vyplnenie použité pre vyplnenie viacerých stránkových dotazníkov.
Použité spoločne s parametrom respondent_key
 
respondent_keyKľúč identifikujúci vyplnenie a respondenta
Použitím tohto parametra systém overí prístup do dotazníka a správne poradie vyplnenia stránky.
 
id_next_pageID stránky, ktorá má byť vyplnená ako ďalšia 
acknowledgmentsObsah ‚ďakovacej’ stránky 
verification_codePotvrdzujúci kód, ktorý je vrátený v prípade, že možnosť „Generovať unikátny kód po vyplnení dotazníka” bola v dotazníku zapnutá 
error_codeKód odpovede, ak prístup do dotazníka zlyhal1 - Neaktívna štúdia
2 - Ukončená štúdia
3 - Nesprávna hodnota parametra url_title
4 - Nesprávna hodnota parametra password
5 - Nesprávna hodnota parametra token
6 - Token je už použitý
7 - Nesprávny kľúč respondenta (: respondent_key)
8 - Neboli vyplnené všetky povinné otázky
9 - Nesprávny typ otázky
10 - Nesprávne poradie dávania odpovedí. Nesprávna hodnota parametra id_page
11 - Respondent ukončil vypĺňanie dotazníka

Začiatok vypĺňania

URL

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

Parametry (GET)

NázevPopis
id_surveyID dotazníka. Povinný parameter

Parametre (POST)

NázovPopis
url_titleParameter vyžadovaný v dotazníkoch so strednou úrovňou ochrany.
Hodnota parametra je názov dotazníka v podobe odkazu dotazníka.
Parameter url_title je vrátený v operácii Informácie o dotazníku
passwordParameter vyžadovaný v dotazníkoch s vysokou úrovňou ochrany.
Prístup do dotazníka vyžaduje heslo.
Heslo je rovnaké pre všetkých respondentov.
tokenParameter vyžadovaný v dotazníkoch s najvyššou úrovňou ochrany.
Prístup k dotazníku vyžaduje token.
Token je heslo na jednorazové použitie, identifikujúce respondenta.

Ukážka odpovede

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

Errors

404 Nenájdené – Dotazník neexistuje.
406 Neprijateľné – Povinné parametre neboli odovzdané.
500 Interná chyba servera – Interná chyba servera.

Zodpovedanie otázok

URL

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

Parametre (GET)

NázovPopis
id_surveyID dotazníka. Povinný parameter
id_responseID vyplnenia. povinný parameter
ID je vrátené v operácii/responses/etaccess

Parametre (POST)

POST parametre sa líšia v závislosti od typu zodpovedaných otázok.
Nižšie uvedené POST parametre sa líšia v závislosti od typu otázky.

NázovPopis
respondent_keyPotvrdzujúci kód respondenta. Kľúč je vrátený operáciou/responses/getaccess
id_pageID stránky vyplnené respondentom
questions[:id_question][type]Typ otázky, odoslaný ako celé číslo. Dostupné hodnoty sú: 0 až 13

Textový blok

NázovHodnotaPopis
questions[:id_question][type] :answer_numberHodnota parametru pro textový blok

Otázka s jednou možnosťou výberu

NázovHodnotaPopis
questions[:id_question][type]0Hodnota parametra pre otázku s jednou možnosťou výberu
questions[:id_question][answer]:answer_numberČíslo odpovede. Odpovede sú očíslované od 1 do 60
questions[:id_question][other_answer][:answer_number]stringOdpoveď poskytnutá respondentom v textovom poli.
Tento parameter je odoslaný pre odpovede, v ktorých respondent môže zadať svoju vlastnú odpoveď.

Otázka s viacerými možnosťami výberu

NázovHodnotaPopis
questions[:id_question][type]6Hodnota parametra pre otázku s viacerými možnosťami výberu
questions[:id_question][answers][:answer_number]truePríznak označujúci, že odpoveď s daným: answer_number bola vybraná respondentom
questions[:id_question][other_answers][:answer_number]stringVlastná odpoveď respondenta. Tento parameter je odoslaný pre odpovede, v ktorých respondent môže zadať vlastnú odpoveď.

Maticová otázka s jednou možnosťou výberu

NázevHodnotaPopis
questions[:id_question][type]1Hodnota parametra pre maticovú otázku s jednou možnosťou výberu
questions[:id_question][answers][:answer_number]:scale_numberV odpovedi číslo :answer_number (očíslované 1 až 60) respondent vybral možnosť číslo :scale_number na stupnici (očíslovanej 1 až 15)

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

NázovHodnotaPopis
questions[:id_question][type]7Hodnota parametra pre maticovú otázku s viacerými možnosťami výberu
questions[:id_question][answers][:answer_number][:scale_number]truePríznak, označujúci, že v odpovedi číslo: answer_number (očíslované 1 až 60) respondent vybral pole v stĺpci číslo: scale_number (očíslované 1 až 15)

Popisová otázka

NázovHodnotaPopis
questions[:id_question][type]2Hodnota parametra pre popisovú otázku
questions[:id_question][answers][]stringPopisová odpoveď poskytnutá respondentom. Tabuľka odpovede má toľko elementov, koľko sa nachádza polí, do ktorých možno zadať popisovať odpoveď v otázke.

Přidělování bodů

NázevHodnotaPopis
questions[:id_question][type]3Hodnota parametra pre otázku prideľovania bodov
questions[:id_question][answers][:answer_number]:points_amountOdpovede číslo: answer_number (očíslované 1 až 60) bolo pridelené nasledovné množstvo bodov:: points_amount

Rankingová otázka

NázovHodnotaPopis
questions[:id_question][type]5Hodnota parametra pre rankingoú otázku
questions[:id_question][answers][:answer_number]:position_numberOdpoveď číslo: answer_number (očíslované 1 až 15) bola umiestnená na pozíciu: position_number (očíslované 1 až 15)

Roletka

NázevHodnotaPopis
questions[:id_question][type]13Hodnota parametra pre roletku
questions[:id_question][answer]:answer_numberRespondent vybral odpoveď na pozíciu: answer_number (očíslované 1 až 60) roletky

Formulář

NázovHodnotaPopis
questions[:id_question][type]4Hodnota parametra pre formulár
questions[:id_question][answers][:answer_numer]stringRespondent zadal svoju odpoveď ako text (string) do poľa číslo: answer_numer (očíslované 1 až 60)

Otázka s posuvníkem (stupnice)

NázovHodnotaPopis
questions[:id_question][type]8Value of the parameter for a slider question
questions[:id_question][answers][:answer_number]int_valueV odpovedi (posuvník) číslo: answer_number (očíslované 1 až 15) nastavil respondent hodnotu int_value (prijíma hodnoty 1 až 100).

Otázka na číslo

NázovHodnotaPopis
questions[:id_question][type]10Hodnota parametra pre otázku na číslo
questions[:id_question][answer]int_valueOdpoveď respondenta má hodnotu int_value

Otázka na e-mailovú adresu

NázovHodnotaPopis
questions[:id_question][type]11Hodnota parametra pre otázku na číslo
questions[:id_question][answer]stringOdpoveď respondenta má hodnotu string

Otázka na datum

NázevHodnotaPopis
questions[:id_question][type]12Hodnota parametra pre otázku na dátum
questions[:id_question][answer]stringOdpoveď respondenta má hodnotu string vo formáte dd-mm-yyyy

Klauzula pre zber osob. údajov

NázovHodnotaPopis
questions[1][type]14Hodnota parametra pre klauzulu úradu pre ochranu osobných údajov
questions[1][answer]truePríznak, určujúci, že respondent poskytol súhlas so spracovaním osobných údajov

Vloženie súboru

Tento typ otázky nie je podporovaný v API

NPS

NázovHodnotaPopis
questions[:id_question][type]0Hodnota parametru pro otázku NPS
questions[:id_question][answer]:answer_numberPočet odpovedí na otázku. Odpovede sú číslované od 1 do 11
questions[:id_question][other_answer][:answer_number]stringOdpoveď na otázku, ktorú respondent uviedol ako odôvodnenie výberu. Tento parameter je odovzdaný pre odpovede, v ktorých je argumentovanie respondenta povolené.

Otvorená maticová otázka

NázovHodnotaPopis
questions[:id_question][type]17Hodnota parametra pre otvorenú maticovú otázku
questions[:id_question][answers][:answer_number][:scale_number]stringOtvorená odpoveď zadaná pre daný riadok a stĺpec

Otázka uchopiť a presunúť

NázovHodnotaPopis
questions[:id_question][type]1Hodnota parametra pre otázku uchopiť a presunúť
questions[:id_question][answers][:answer_number]:scale_numberOdpovede podľa čísla:: answer_number (očíslované od 1 do 100) boli priradené k skupine čísel: scale_number (očíslované od 1 do 15)

Ukážka odpovede

{
	"id_next_page":269666,
}	

Ukážka odpovede II

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

Chybové hlášky

404 Nenájdené – Dotazník neexistuje.
406 Neprijateľné – Povinné parametre neboli odovzdané.
500 Interná chyba servera – Interná chyba servera.

Určenie doby vyplnenia

URL

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

Parametre (GET)

NázovPopis
id_surveyID dotazníka. Povinný parameter
id_responseID vyplnenie. Povinný parameter. ID je vrátené operáciou/responses/getaccess

Parametre (POST)

NázovPopis
respondent_keyOverovací kľúč respondenta. Kľúč je vrátený operáciou/responses/getaccess
date_survey_openPovinný parameter. Dátum a čas prvého otvorenia dotazníka. Formát dátumu je: 2012-12-06 12:00:00
date_survey_answerPovinný parameter. Dátum a čas vyplnenia dotazníka. Formát dátumu je: 2012-12-06 12:00:00

Ukážka odpovede

{
	"confirmation":true
}

Errors

404 Zlá požiadavka – Nesprávny formát dátumu.
404 Nenájdené – Dotazník neexistuje.
406 Neprijateľné – Povinné parametre neboli odovzdané.
500 Interná chyba servera – Interná chyba servera.

Pomohol Vám tento článok?

Ďakujeme za odpoveď