Lista operacji dla zasobu

Nazwa	URL	Opis
Lista szablonów mailingów	`/mailing/templates`	Zwraca listę wszystkich szablonów mailingów dla zalogowanego użytkownika. Szablony posortowane wg. daty dodania rosnąco.
Tworzenie mailingu	`/mailing/create`	Zlecenie wysyłki do wybranej grupy respondentów
Wysyłka zaproszeń z użyciem batch_id	`/mailing/batch`	Operacja do zdefiniowania mailingu. Aby zdefiniować mailing trzeba dodać respondentów do `patch-a`

Opis parametrów odpowiedzi

Nazwa/ścieżka	Opis	Możliwe wartości
`id`	ID ankiety
`name`	Tytuł szablonu
`subject`	Tytuł mailingu
`content`	Treść wiadomości w mailingu
`date_created`	Data utworzenia szablonu
`id_mailing`	ID stworzonego mailingu w systemie
`receivers`	liczba respondentów, którzy otrzymają zaproszenie
`footer`	możliwość wyłączenia stopki z informacją o nadawcy. Domyślnie stopka jest wyłączona

Lista szablonów mailingów

URL

(GET) https://www.webankieta.pl/api/v2/mailing/templates

Przykładowa odpowiedź

{
  ["total"] => string(1) "2"
  ["list"] => array(2) {
    [0] => array(5) {
      ["id"] => int(7)
      ["name"] => string(7) "Testowa"
      ["subject"] => string(35) "Zaproszenie do wypełnienia ankiety"
      ["content"] => string(251) "<p>Witaj,<br /> <br /> Zapraszam do wypełnienia ankiety na temat ...<br /> Wypełnienie ankiety powinno zająć około ... minut<br /> <br /> Aby wypełnić ankietę kliknij na link:<br /> [LINK]<br /> <br /> <br /> <br /> Dziękuję i pozdrawiam</p>"
      ["date_created"] => string(19) "2015-04-24 13:36:00"
    }
    [1] => array(5) {
      ["id"] => int(8)
      ["name"] => string(8) "Testowa2"
      ["subject"] => string(35) "Zaproszenie do wypełnienia ankiety"
 <p>testowa 2<br /> <br /> Zapraszam do wypełnienia ankiety na temat ...<br /> Wypełnienie ankiety powinno zająć około ... minut<br /> <br /> Aby wypełnić ankietę kliknij na link:<br /> [LINK]<br /> <br /> <br /> <br /> Dziękuję i pozdrawiam</p>"
      ["date_created"] => string(19) "2015-04-24 13:36:19"
    }
  }
}

Zwracane błędy

Brak

Tworzenie mailingu

URL

(POST) https://www.webankieta.pl/api/v2/mailing/create

Parametry POST

Nazwa/ścieżka	Opis	Możliwe wartości
`id_survey`	ID ankiety
`id_template`	ID szablonu zaproszenia
`date_send`	data wysyłki mailingu
`mode`	tryb wysyłki mailingu	`all` - wszyscy zaimportowani respondenci `new` - tylko nowi respondenci, którzy nie zostali jeszcze zaproszeni `reminders` - wysyłka do osób, które otrzymały zaproszenie, ale nie wypełnili jeszcze ankiety `selected` - respondenci wybrani
`respondent_ids`	lista respondentów do których trzeba wysłać badanie; obowiązkowy przy opcji `mode=selected`
`footer`	możliwość wyłączenia stopki z informacją o nadawcy. Domyślnie stopka jest wyłączona	1 - włączona 0 - wyłączona

Przykładowa odpowiedź

[
   {
      ["id_mailing"] => string(3) "585",
      ["receivers"] => int(0)
   }
]

Zwracane błędy

• 400 Bad request – Nieprawidłowy format daty, nieprawidłowy status lub
nieprawidłowy poziom bezpieczeństwa
• 401 Unautorized – Brak dostępu do szablonu o podanym ID
• 403 Forbidden – Przekroczone limity wysyłek zaproszeń na koncie
• 404 Not found – Nie znaleziono ankiety o podanym ID na koncie zalogowanego
użytkownika
• 500 Internal Server Error – Wewnętrzny błąd serwera

Wysyłka zaproszeń z użyciem batch_id

POST

(POST) webankieta.pl/api/v2/mailing/batch

Parametry (POST)

Nazwa	Opis
`batch_id`	ID batch’a
`template_id`	ID wybranego szablonu zaproszenia do wysyłki
`with_reminder`	wartość bool decydująca o tym czy ma zostać wysłane przypomnienie do respondentów, którzy nie wypełnią ankiety. Parametr opcjonalny. Domyślna wartość: false.
`reminder_template_id`	ID wybranego szablonu zaproszenia do wysyłki przypomnienia. Parametr wymagany jeśli parametr with_reminder został ustawiony na wartość true. Jak pozyskać template_id?
`reminder_delay`	liczba godzin od wysyłki, po której ma zostać wysłane przypomnienie dla respondentów, którzy nie wypełnili ankiety. Parametr wymagany jeśli parametr with_reminder został ustawiony na wartość true.

Zwracane wartości json:

Nazwa	Opis
`mailing_id`	ID utworzonego mailingu