Seznam operací pro zdroj
| Název | URL | Popis |
|---|---|---|
| Seznam šablon mailingů | /mailing/templates | Vrací seznam všech šablon mailingu pro přihlášeného uživatele. Šablony jsou tříděné vzestupně dle data přidání. |
| Tvorba mailingu | /mailing/create | Operace pro definování mailingu. Argumenty jsou ID šablony a skupina respondentů. Po vytvoření je mailing okamžitě rozeslán příjemcům |
Popis parametrů odpovědi
| Název/cesta | Popis | Možné hodnoty |
|---|---|---|
id | ID dotazníku | |
name | Název šablony | |
subject | Subjekt mailingu | |
content | Obsah zprávy mailingu | |
date_created | Datum vytvoření šablony | |
id_mailing | ID vytvořeného mailingu v systému | |
receivers | Počet respondentů, kteří obdrží pozvánku | |
footer | Možnost vypnutí zápati s informací o odesílateli. Ve výchozím nastavení zapnuto |
Seznam šablon mailingů
URL
(GET) https://www.netquest.cz/api/mailing/templates
Nepovinné parametry (POST)
Žádné
Ukázka odpovědi
{
["total"] => string(1) "2"
["list"] => array(2) {
[0] => array(5) {
["id"] => int(7)
["name"] => string(7) "Test"
["subject"] => string(35) "Pozvánka k vyplnění dotazníku"
["content"] => string(251) "<p>Ahoj,<br /> <br />rád bych Vás pozval k vyplnění dotazníku ... <br />Vyplnění by nemělo zabrat více než ... minut <br /> <br /> Pro vyplnění dotazníku klikněte na následující odkaz. <br /> [LINK]<br /> <br /> <br /> <br />Děkuji. <br /> S pozdravem </p>"
["date_created"] => string(19) "2019-04-24 13:36:00" }
Ahoj,
rád bych Vás pozval k vyplnění dotazníku …
Vyplnění by nemělo zabrat více než … minut
Pro vyplnění dotazníku klikněte na následující odkaz.
[LINK]
Děkuji.
S pozdravem
Chybové hlášky
Žádné
Tvorba mailingu
URL
(GET) https://www.netquest.cz/api/mailing/create
Parametry (POST)
| Název | Popis |
|---|---|
id_survey | ID dotazníku |
id_template | ID šablony mailingu |
date_send | Datum rozeslání mailingu ve formátu yyyy-mm-dd hh:mm:ss |
mode | Možný výběr respondentů mailingu:all – všichni respondenti ze seznamunew – všichi nově přidaní respondenti, kterým ještě nebyl mailing odeslánreminders – připomenutí osobám, kteří si zobrazili pozvánku, ale ještě nevyplnili dotazníkselected – vybraní respondenti. Při výběru tohoto parametru je nutné předat ID respondentů v následujícím parametru. |
respondents_ids | ID respondentů poskytnutých za desetinnou čárkou. Tento parametr je povinný v případě režimu mode=selected |
Ukázka odpovědi
[
{
["id_mailing"] => string(3) "585"
["receivers"] => int(0)
}
]
Chybové hlášky
400 Špatný požadavek– Nesprávný formát datumu, nesprávný status nebo nesprávná úroveň zabezpečení dotazníku401 Neautorizováno– Žádný přístup k šabloně s daným ID404 Nenalezeno– Nebyly nalezeny žádné dotazníky daného ID v účtu přihlášeného uživatele500 Interní chyba serveru– Interní chyba serveru