Respondenti

Seznam operací pro zdroj

Název	URL	Popis
Seznam respondentů	`/respondents/:id_survey`	Vrací seznam všech respondentů z dotazníku, určené podle parametru `:id_survey`. Respondenti jsou řazeni abecedně podle e-mailové adresy.
Vyhledávání respondenta	`/respondents/search/:id_survey`	Vyhledává respondenty dle kritéria daného v tabulce `POST`
Přidání respondenta do dotazníku	`/respondents/add`	Přiřadí kontakt k dotazníku
Odstranění respondenta	`/respondents/delete`	Odebere respondenta z dotazníku

Popis parametrů odpovědi

Název/cesta	Popis	Možné hodnoty
`id`	ID respondenta
`token`	Unikátní token, který přesně identifikuje respondenta. Používá se na jednorázové vyplnění dotazníku respondentem. Parametr je aktivní pouze pro dotazníky s nejvyšší úrovni ochrany.
`offline_distribution`	Informace o tom, zda pozvánku k dokončení průzkumu zpracoval Netquest nebo webové stránky autora. Předání user_token do odkazu k dokončení průzkumu se rovněž považuje za distribuci ze strany autora.	`0` – Odkaz do dotazníku byl odeslán z Netquest.cz `1` – Odkaz do dotazníku byl odeslá autorem (Offline distribuce tokenů)
`date_generate`	Datum přidání respondenta do dotazníku
`date_invitation_send`	Datum a hodina zaslání pozvánky	`null` – Pozvánka nebyla odeslána `0000-00-00 00:00:00` – Pozvánka očekává odeslání `2012-12-06 12:00:00` – Datum a hodina odeslání pozvánky
`date_survey_open`	Datum a hodina prvního otevření dotazníku. Parametr je aktivní pouze s nějvyšší úrovní ochrany dotazníku.	`null` – Dotazník nebyl respondentem otevřen `2012-12-06 12:00:00` – Datum a hodina otevření dotazníku
`date_survey_answer`	Datum a hodina vyplnění dotazníku. Parametr je aktivní pouze s nejvyšší úrovní ochrany dotazníku.	`null` – Dotazník nebyl respondentem vyplněn `2012-12-06 12:00:00` – Datum a hodina vyplnění dotazníku
`answer_postponed`	Byla-li respondentova odpověď odložena během vyplňování dotazníku. Parametr je aktivní pouze s nějvyšší úrovní ochrany dotazníku.	`null` – Dotazník není vyplněn `0` – Vyplnění není odloženo `1` – Vyplnění odloženo
`email`	E-mailová adresa respondenta
`label1`	Hodnota prvního nepovinného štítku. Štítek je aktivní pokud byl respondent přidán z kontaktů uživatele.
`label2`	Hodnota druhého nepovinného štítku. Štítek je aktivní pokud byl respondent přidán z kontaktů uživatele.
`label3`	Hodnota třetího nepovinného štítku. Štítek je aktivní pokud byl respondent přidán z kontaktů uživatele.
`label4`	Hodnota čtvrtého nepovinného štítku. Štítek je aktivní pokud byl respondent přidán z kontaktů uživatele.
`label5`	Hodnota pátého nepovinného štítku. Štítek je aktivní pokud byl respondent přidán z kontaktů uživatele.
`survey_link`	Unikátní odkaz dotazníku určený pro daného respondenta. Parametr je aktivní pouze s nejvyšší ochranou dotazníku.

Seznam respodentů

URL

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

Nepovinné parametry (POST)

Název	Popis
`limit`	Limit v počtu vyplnění
`offset`	Offset na seznamu

Ukázka odpovědi

{
	"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":"[email protected]",
		"label1":"Petr",
		"label2":"Novak",
		"label3":"774 700 800",
		"label4":"",
		"label5":"",
		"answer_postponed":null
	},{
		...
	}]
}

Chybové hlášky

401 Neautorizováno – Uživatel odkazuje na zdroj, který nevlastní.
404 Nenalezeno – Nebyl nalezen žádný dotazník daného :id_survey.
404 Nenalezeno – Nebyli nalezeni žádní respondenti.
406 Nepřijatelné – Nebyl předán žádný parametr :id_survey.

Vyhledávání respondenta

URL

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

Nepovinné parametry (POST)

Název	Popis
`limit`	Limit v počtu vyplnění
`offset`	Offset na seznamu
`token`	Vyhledávání respondenta dle tokenu
`email`	Vyhledávání respondenta dle e-mailové adresy
`date_generate`	Vyhledávání respondenta podle data přidání do dotazníku Datum musí být odesláno ve tvaru `YYYY-MM-DD` (např. 2011-11-20). Budou prohledáváni všichni respondenti přidaní tento den.
`date_invitation_send`	Vyhledávání respondenta podle data odeslání pozvánky Datum musí být odesláno ve tvaru `YYYY-MM-DD` (např. 2011-11-20). Budou prohledáváni všichni respondenti, jímž byla odeslána pozvánka tento den.
`date_survey_open`	Vyhledávání respondenta podle data prvního otevření dotazníku Datum musí být odesláno ve tvaru `YYYY-MM-DD` (např. 2011-11-20). Budou prohledáváni všichni respondenti, kteří otevřeli dotazník tento den.
`date_survey_answer`	Vyhledávání respondenta podle data vyplnění dotazníku Datum musí být odesláno ve tvaru `YYYY-MM-DD` (např. 2011-11-20). Budou prohledáváni všichni respondenti, kteří vyplnili dotazník tento den.
`label1`	Vyhledávání respondenta podle hodnoty prvního štítku
`label2`	Vyhledávání respondenta podle hodnoty druhého štítku
`label3`	Vyhledávání respondenta podle hodnoty třetího štítku
`label4`	Vyhledávání respondenta podle hodnoty čtvrtého štítku
`label5`	Vyhledávání respondenta podle hodnoty pátého štítku

Ukázka odpovědi

{
	"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":"[email protected]",
		"label1":"Petr",
		"label2":"Novak",
		"label3":"774 700 800",
		"label4":"",
		"label5":"",
		"answer_postponed":null
	},{
		...
	}]
}

Chybové hlášky

401 Neautorizováno – Uživatel odkazuje na zdroj, který nevlastní.
404 Nenalezeno – Nebyl nalezen žádný dotazník daného :id_survey.
404 Nenalezeno – Nebyli nalezeni žádní respondenti.
406 Nepřijatelné – Nebyl předán žádný :id_survey.

Přidání respondenta do dotazníku

URL

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

Parametry (POST)

Název	Popis
`id_survey`	ID dotazníku do které byl kontakt přidán
`id_contact`	ID kontaktu přidaného do dotazníku
`date_invitation_send`	Datum odeslání pozvánky respondentovi (odeslání proběhlo na straně aplikace klienta). Nepovinný parametr

Ukázka odpovědi

{
        "id_respondent":"101019"
        }

Chybové hlášky

401 Neautorizováno – Uživatel odkazuje na zdroj, který nevlastní (dotazník/kontakt).
404 Nenalezeno – Nebyl nalezen žádný dotazník daného :id_survey.
404 Nenalezeno – Nebyl nalezen žádný kontakt :id_contact.
406 Nepřijatelné – Nebyl předán žádný :id_survey.
406 Nepřijatelné – Nebyl předán žádný :id_contact.
409 Konflikt – Kontakt byl do dotazníku již přidán.

Odstranění respondenta

URL

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

Parametry (POST)

Název	Popis
`id_survey`	ID dotazníku do kterého respondent spadá
`id_respondent`	ID respondenta

Ukázka odpovědi

{
  "status":"ok"
}

Chybové hlášky

401 Neautorizováno – Uživatel odkazuje na zdroj, který nevlastní (dotazník/kontakt).
404 Nenalezeno – Nebyl nalezen žádný dotazník daného :id_survey.
404 Nenalezeno – Nebyl nalezen žádný respondent daného :id_respondent.

Pruvodce - API

Seznam operací pro zdroj

Popis parametrů odpovědi

Seznam respodentů

URL

Nepovinné parametry (POST)

Ukázka odpovědi

Chybové hlášky

Vyhledávání respondenta

URL

Nepovinné parametry (POST)

Ukázka odpovědi

Chybové hlášky

Přidání respondenta do dotazníku

URL

Parametry (POST)

Ukázka odpovědi

Chybové hlášky

Odstranění respondenta

URL

Parametry (POST)

Ukázka odpovědi

Chybové hlášky

Pomohl Vám tento článek?

Instrukce