Sprievodca - API

Respondenti

Zoznam operácií pre zdroj

Názov URL Popis
Zoznam respondentov /respondents/:id_survey Zoznam operácií pre zdroj vracia zoznam všetkých respondentov z dotazníka, určenej podľa parametra: id_survey.
Respondenti sú radení abecedne podľa e-mailovej adresy.
Vyhľadávanie respondenta /respondents/search/:id_survey Respondenti sú radiení abecedne podľa e-mailovej adresy.
Vyhľadávanie respondenta / respondenti / hľadanie /: id_survey Vyhledává respondenty podľa kritérií uvedených v tabuľke POST
Pridanie respondeta /respondents/add Přiřadí kontakt k dotazníku
Odstránenie respondenta /respondents/delete Odebere respondenta z dotazníku

Popis parametrů odpovědi

Názov/cesta Popis Možné hodnoty
id ID respondenta
token Unikátny token, ktorý presne identifikuje respondenta. Používa sa na jednorazové vyplnenie dotazníka respondentom.
Parameter je aktívna len pre dotazníky s najvyššej úrovni ochrany.
offline_distribution Informácie o tom, či pozvánku na dokončenie prieskumu spracoval Netquest alebo webové stránky autora. Odovzdanie user_token do odkazu na dokončenie prieskumu sa tiež považuje za distribúciu zo strany autora. 0 – Odkaz do dotazníka bol odoslaný z Netquest.sk
1 – Odkaz do dotazníka bol odoslať autorom (offline distribúcia tokenov)
date_generate Dátum pridania respondenta do dotazníka
date_invitation_send Datum a hodina zaslání pozvánky null – Pozvánka nebola odoslaná
0000-00-00 00:00:00 – Pozvánka očakáva odoslanie
2012-12-06 12:00:00 – Dátum a hodina odoslania pozvánky
date_survey_open Dátum a hodina prvého otvorenia dotazníka.
Parameter je aktívna len s najvyššou úrovňou ochrany dotazníka.
null – Dotazník nebol respondentom otvorený
2012-12-06 12:00:00 – Dátum a hodina otvorenia dotazníka
date_survey_answer Dátum a hodina vyplnenie dotazníka.
Parameter je aktívna len s najvyššou úrovňou ochrany dotazníka.
null – Dotazník nebol respondentom vyplnený
2012-12-06 12:00:00 – Dátum a hodina vyplnenie dotazníka
answer_postponed Ak bola respondentova odpoveď odložená počas vyplňovania dotazníka.
Parameter je aktívna len s najvyššou úrovňou ochrany dotazníka.
null – Dotazník není vyplněn
0 – Vyplnění není odloženo
1 – Vyplnění odloženo
email E-mailová adresa respondenta
label1 Hodnota prvého nepovinného štítku.
Štítok je aktívna ak bol respondent pridaný z kontaktov používateľa.
label2 Hodnota druhého nepovinného štítku.
Štítok je aktívna ak bol respondent pridaný z kontaktov používateľa.
label3 Hodnota tretieho nepovinného štítku.
Štítok je aktívna ak bol respondent pridaný z kontaktov používateľa.
label4 Hodnota štvrtého nepovinného štítku.
Štítok je aktívna ak bol respondent pridaný z kontaktov používateľa.
label5 Hodnotata piateho nepovinného štítku.
Štítok je aktívna ak bol respondent pridaný z kontaktov používateľa.
survey_link Unikátny odkaz dotazníka určený pre daného respondenta.
Parameter je aktívna len s najvyššou ochranou dotazníka.

Zoznam respondentov

URL

(GET) https://www.netquest.sk/api/respondents/:id_survey

Nepovinné parametre (POST)

Názov Popis
limit Limit v počte vyplnení
offset Offset na zozname

Ukážka odpovede

{
	"total":"20",
	"list":[{
		"id":100824,
		"token":"549E56",
		"date_token_generate":"2011-11-25 22:27:42",
		"date_invitaion_send":null,
		"date_survey_open":null,
		"date_survey_answer":null,
		"email":"petr.novak@netquest.sk",
		"label1":"Petr",
		"label2":"Novak",
		"label3":"774 700 800",
		"label4":"",
		"label5":"",
		"answer_postponed":null
	},{
		...
	}]
}

Chybové hlášky

  • 401 Neautorizované – Užívateľ odkazuje na zdroj, ktorý nevlastní.
    404 Nenájdené – Nenašiel sa žiadny dotazník daného: id_survey.
    404 Nenájdené – Neboli nájdení žiadni respondenti.
    406 Neprijateľné – Nebol odovzdaný žiadny parameter: id_survey.

Vyhľadávanie respondenta

URL

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

Nepovinné parametry (POST)

Název Popis
limit Limit v počtu vyplnení
offset Offset na zozname
token Vyhľadávanie respondenta podľa tokenu
email Vyhľadávanie respondenta podľa e-mailovej adresy
date_generate Vyhľadávanie respondenta podľa dátumu pridania do dotazníka
Dátum musí byť odoslaný v tvare YYYY-MM-DD (napr. 2011-11-20).
Prehľadajú všetci respondenti pridaní tento deň.
date_invitation_send Vyhľadávanie respondenta podľa dátumu odoslania pozvánky
Dátum musí byť odoslaný v tvare YYYY-MM-DD (napr. 2011-11-20).
Prehľadajú všetci respondenti, ktorým bola odoslaná pozvánka tento deň.
date_survey_open Vyhľadávanie respondenta podľa dátumu prvého otvorenia dotazníka
Dátum musí byť odoslaný v tvare YYYY-MM-DD (napr. 2011-11-20).
Prehľadajú všetci respondenti, ktorí otvorili dotazník tento deň.
date_survey_answer Vyhľadávanie respondenta podľa dátumu vyplnenie dotazníka
Dátum musí byť odoslaný v tvare YYYY-MM-DD (napr. 2011-11-20).
Prehľadajú všetci respondenti, ktorí vyplnili dotazník tento deň.
label1 Vyhľadávanie respondenta podľa hodnoty prvého štítku
label2 Vyhľadávanie respondenta podľa hodnoty druhého štítku
label3 Vyhľadávanie respondenta podľa hodnoty tretieho štítku
label4 Vyhľadávanie respondenta podľa hodnoty štvrtého štítku
label5 Vyhľadávanie respondenta podľa hodnoty piateho štítku
{
	"total":"20",
	"list":[{
		"id":100824,
		"token":"549E56",
		"date_token_generate":"2011-11-25 22:27:42",
		"date_invitaion_send":null,
		"date_survey_open":null,
		"date_survey_answer":null,
		"email":"petr.novak@netquest.sk",
		"label1":"Petr",
		"label2":"Novak",
		"label3":"774 700 800",
		"label4":"",
		"label5":"",
		"answer_postponed":null
	},{
		...
	}]
}

Chybové hlášky

  • 401 Neautorizované – Užívateľ odkazuje na zdroj, ktorý nevlastní.
    404 Nenájdené – Nenašiel sa žiadny dotazník daného: id_survey.
    404 Nenájdené – Neboli nájdení žiadni respondenti.
    406 Neprijateľné – Nebol odovzdaný žiadny: id_survey.

Pridanie respondenta do dotazníka

URL

(GET) https://www.netquest.sk/api/respondents/add

Parametry (POST)

Název Popis
id_survey ID dotazníka do ktorého bol kontakt pridaný
id_contact ID kontaktu pridaného do dotazníka
date_invitation_send Dátum odoslania pozvánky respondentovi (odoslanie prebehlo na strane aplikácie klienta).
Nepovinný parameter

Ukázka odpovědi

{
        "id_respondent":"101019"
        }

Chybové hlášky

  • 401 Neautorizované – Užívateľ odkazuje na zdroj, ktorý nevlastní (dotazník / kontakt).
    404 Nenájdené – Nenašiel sa žiadny dotazník daného: id_survey.
    404 Nenájdené – Nebol nájdený žiadny kontakt: id_contact.
    406 Neprijateľné – Nebol odovzdaný žiadny: id_survey.
    406 Neprijateľné – Nebol odovzdaný žiadny: id_contact.
    409 Konflikt – Kontakt bol do dotazníka už pridaný.

Odstránenie respondenta

URL

(GET) https://www.netquest.sk/api/respondents/delete

Parametre (POST)

Názov Popis
id_survey ID dotazníka do kterého respondent spadá
id_respondent ID respondenta

Ukážka odpovede

{
  "status":"ok"
}

Chybové hlášky

  • 401 Neautorizovaný – Užívateľ odkazuje na zdroj, ktorý nevlastní (dotazník / kontakt).
  • 404 Nenájdené Nenašiel sa žiadny dotazník daného: id_survey.
  • 404 Nenájdené Nenašiel sa žiadny respondent daného: id_respondenta

Pomohol Vám tento článok?

Ďakujeme za odpoveď