Lista operacji dla zasobu

Nazwa

URL

Opis

Lista ankiet

/surveys

Zwraca listę wszystkich ankiet dla zalogowanego użytkownika. Ankiety posortowane wg. daty dodania rosnąco.

Wyszukiwanie ankiet

/surveys/search

Zwraca listę ankiet pasujących do kryteriów wyszukiwania. Ankiety posortowane wg. daty dodania rosnąco.

Informacje o ankiecie

/surveys/:id

Szczegółowe informacje o ankiecie. W odróżnieniu do danych z poprzedniej operacji tutaj zwrócone zostanę informacje o domenie, skórce, oraz podstawowe informacje o pytaniach w podziale na strony

Aktywacja ankiety

/surveys/activate/:id

Rozpoczęcie zbierania wyników w ankiecie

Dezaktywacja ankiety

/surveys/deactivate/:id

Zakończenie zbierania wyników w ankiecie. Status ankiety będzie ustawiony na tworzenie ankiety (1) lub Analiza Wyników (3) w zależności od zebranych wyników.

Opis parametrów odpowiedzi

Nazwa/ścieżka

Opis

Możliwe wartości

id

ID ankiety

title

Tytuł ankiety

internal_title

Tytuł ankiety wyświetlany w panelu użytkownika

url_title

Tytuł ankiety używany w „przyjaznych linkach”

date_created

Data stworzenia ankiety

date_published

Data pierwszej publikacji ankiety – rozpoczęcie zbierania wyników

null – jeśli nie była publikowana
$data – jeśli była publikowana

date_modified

Data ostatniej modyfikacji ankiety

null – jeśli nie była modyfikowana
$data – jeśli była modyfikowana

date_end

Data pierwszego zakończenia zbierania wyników

null – jeśli nie była zakończona
$data – jeśli była zakończona

answers_count

Liczba wypełnień ankiety

status

Status ankiety

0 – Tworzenie ankiety
1 – Zbieranie wyników
2 – Analiza wyników

type

Typ ankiety

0 – Badanie
1 – Test

personal_data

Dane osobowe w ankiecie

0 – nie są zbierane

1 – są zbierane

lang_code

Język interfejsu ankiety

pl – polski
en – angielski

security_level

Poziom bezpieczeństwa ankiety

0 – Niskie – Każdy może ją wypełnić.

1 – Średnie – Ankieta dostępna tylko przez link bezpośredni.

2 – Wysokie – Ankieta dostępna tylko po wpisaniu hasła. To samo hasło dla wszystkich.

3 – Najwyższe – Ankieta zabezpieczona kodem jednorazowego użytku (tokenem). Tyle tokenów ilu respondentów.

anonymous

Identyfikacja respondentów

0 – Włączona – możesz powiązać wypełnienie z respondentem. 1 – Wyłączona – tokeny nie pozwalają na identyfikację respondenta. Ankieta jest anonimowa.

password

Hasło dostępu do ankiety. Ustawiane jeśliStatus == 2

public_results

Wyniki ankiety

0 – niedostępne publicznie

1 – dostępne publicznie

many_answers_from_cookie

Wypełnienie ankiety

0 – Tylko raz z jednego komputera

1 – Dowolna ilość wypełnień z jednego komputera

email_notification

Powiadomienie o wypełnieniu ankiety via e-mail

0 – Wyłączone
1 – Włączone

comments

Respondenci mogą skomentować ankietę

0 – Wyłączone
1 – Włączone

social_media

Respondenci mają możliwość umieszczenia linku do ankiety w różnych serwisach społecznościowych

0 – Wyłączone
1 – Włączone

contact_with_author_form

Wyświetlanie przycisku pozwalający na kontakt z autorem ankiety

0 – Wyłączone
1 – Włączone

question_numbers

Wyświetlanie numerów pytań

0 – Wyłączone
1 – Włączone

progress_bar

Wyświetlanie paska postępu wypełniania ankiety

0 – Wyłączone
1 – Włączone

partial_answers

Respondenci mogą odłożyć wypełnianie na później

0 – Wyłączone
1 – Włączone

reversible

Wyświetlanie przycisku 'Wstecz' w ankietach mających więcej niż jedną stronę

0 – Wyłączone
1 – Włączone

answers_limit

Wartość limitu wypełnień po którym nastąpi zakończenie badania

autostart_date

Data po osiągnięciu której ankieta zostanie automatycznie aktywowana

expiration_date

Data po osiągnięciu której ankieta zostanie automatycznie zakończona

search_engines

Indeksowanie ankiety przez roboty internetowe

0 – Wyłączone
1 – Włączone

archive

Informacja o tym, czy ankieta została zarchiwizowana

0 – Nie zarchiwizowana
1 – Zarchiwizowana

action_after_answer

Akcja po wypełnieniu

0 – Wyświetlenie ekranu podziękowania
1 – Powrót do początku ankiety
2 – Przekierowanie na zewnętrzny adres

redirection

Adres strony przekierowania, na którą zostanie przekierowany respondent po wypełnieniu ankiety, jeżeliaction_after_answer == 2

thank_you_text

Tekst podziękowania wyświetlany po zakończeniu ankiety

pages.questions.type

Typ pytania

0 – Jednokrotnego wyboru
1 – Macierzowe jednokrotne
2 – Opisowe
4 – Formularz
5 – Rankingowe
6 – Wielokrotnego wyboru
7 – Macierzowe wielokrotne
8 – Suwakowe
9 – Blok opisowy
10 – Liczba
11 – E-mail
12 – Data
13 – Lista rozwijalna
14 – Klauzula GIODO
15 – Upload pliku
16 – NPS
17 – Macierzowe opisowe
19 – Przeciągnij i upuść

Lista ankiet

URL

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

Parametry opcjonalne (POST)

Nazwa

Opis

limit

Limit na liczbę ankiet

offset

Offset na listę

Przykładowa odpowiedź


[
{
"id":69047,
"title":"Tytul ankiety testowej",
"url_title":"tytul-ankiety-testowej",
"date_created":"2011-09-19 13:22:06",
"date_published":"2011-09-19 13:23:10",
"date_modified":"2011-09-19 13:23:10",
"date_end":null,
"answers_count":0,
"status":1,
"type":0,
"personal_data":0,
"lang_code":"pl",
"security_level":0,
"anonymous":0,
"password":"",
"public_results":1,
"many_answers_from_cookie":1,
"email_notification":0,
"comments":1,
"social_media":1,
"contact_with_author_form":1,
"question_numbers":1,
"progress_bar":0,
"partial_answers":0,
"reversible":0,
"answers_limit":0,
"expiration_date":null,
"search_engines":1,
"action_after_answer":0,
"redirection":null,
"thank_you_text":"Dzi\u0119kujemy za wype\u0142nienie ankiety"
},
{
...
}
]

Zwracane błędy

Brak

Wyszukiwanie ankiet

URL

(GET) https://www.webankieta.pl/api/v2/surveys/search

Parametry opcjonalne (POST)

Nazwa

Opis

title

Tytuł ankiety

date_created

Data stworzenia ankiety. Data musi być przekazana w formacie YYYY-MM-DD (np. 2011-11-20). Po przekazaniu parametru zostaną zwrócone wszystkie ankiety stworzone danego dnia.

date_published

Data pierwszej publikacji ankiety. Data musi być przekazana w formacie YYYY-MM-DD (np. 2011-11-20). Po przekazaniu parametru zostaną zwrócone wszystkie ankiety opublikowane danego dnia.

date_end

Data pierwszego zakończenia zbierania wyników. Data musi być przekazana w formacie YYYY-MM-DD (np. 2011-11-20). Po przekazaniu parametru zostaną zwrócone wszystkie ankiety zakończone danego dnia.

status

Status ankiety. Dozwolone wartości to: 0, 1 i 2

type

Typ ankiety. Dozwolone wartości to: 0 – ankieta, 1 – test i 2 – widget

security_level

Poziom zabezpieczeń ankiety. Dozwolone wartości to: 0, 1 i 2, 3

limit

Limit na liczbę ankiet

offset

Offset na listę

Przykładowa odpowiedź

[
{
"id":69047,
"title":"Tytul ankiety testowej",
"internal_title":"[Projekt] Tytul ankiety testowej",
"url_title":"tytul-ankiety-testowej",
"date_created":"2011-09-19 13:22:06",
"date_published":"2011-09-19 13:23:10",
"date_modified":"2011-09-19 13:23:10",
"date_end":null,
"answers_count":0,
"status":1,
"type":0,
"personal_data":0,
"lang_code":"pl",
"security_level":0,
"anonymous":0,
"password":"",
"public_results":1,
"many_answers_from_cookie":1,
"email_notification":0,
"comments":1,
"social_media":1,
"contact_with_author_form":1,
"question_numbers":1,
"progress_bar":0,
"partial_answers":0,
"reversible":0,
"answers_limit":0,
"expiration_date":null,
"search_engines":1,
"action_after_answer":0,
"redirection":null,
"thank_you_text":"Dzi\u0119kujemy za wype\u0142nienie ankiety"
},
{
...
}
]

Zwracane błędy

  • 400 Bad request – Nieprawidłowy format daty, nieprawidłowy status lub nieprawidłowy poziom bezpieczeństwa

  • 500 Internal Server Error – Wewnętrzny błąd serwera.

Informacje o ankiecie

URL

(GET) https://www.webankieta.pl/api/v2/surveys/:id

Parametry

brak

Przykładowa odpowiedź

{
"id":69047,
"title":"Tytul ankiety testowej",
"url_title":"tytul-ankiety-testowej",
"internal_title":"[Projekt] Tytul ankiety testowej",
"date_created":"2011-09-19 13:22:06",
"date_published":"2011-09-19 13:23:10",
"date_modified":"2011-09-19 13:23:10",
"date_end":null,
"answers_count":0,
"status":1,
"type":0,
"personal_data":0,
"lang_code":"pl",
"security_level":0,
"anonymous":0,
"password":"",
"public_results":1,
"many_answers_from_cookie":1,
"email_notification":0,
"comments":1,
"social_media":1,
"contact_with_author_form":1,
"question_numbers":1,
"progress_bar":0,
"partial_answers":0,
"reversible":0,
"answers_limit":0,
"expiration_date":null,
"search_engines":1,
"action_after_answer":0,
"redirection":null,
"thank_you_text":"Dzi\u0119kujemy za wype\u0142nienie ankiety",
"domain":{
"type":"subdomain",
"main":false,
"address":"subdomena.webankieta.pl"
},
"pages":[
{
"id":261181,
"number":1,
"questions":[
{
"id":804039,
"type":9,
"order":1,
"number":0,
"text":"Blok opisowy",
"desc":"Witamy.",
"date_created":"2011-05-06 00:39:14"
},
{
"..."
}
]
},
{
"id":261182,
"number":2,
"questions":[
{
"id":804041,
"type":0,
"order":1,
"number":1,
"text":"Sk\u0105d dowiedzieli si\u0119 Pa\u0144stwo o naszej restauracji?",
"desc":"",
"date_created":"2011-06-27 16:29:50"
},
{
"..."
}
]
}
],
"skin":{
"id":"115",
"name":"Ankieta.biz",
"head_background":"ffffff",
"progress_bar_background":"93341E",
"title_color":"93341E",
"title_border":"eeeeee",
"question_color":"93341E",
"button_color":"ffffff",
"button_background":"93341E",
"logo":"http:\/\/www.webankieta.pl\/user_files\/user_logo\/16552\/ankietabiz.png"
}
}

Zwracane błędy

  • 404 Not Found – Zasób nie został znaleziony lub nie istnieje.

Aktywacja ankiety

URL

(GET) https://www.webankieta.pl/api/v2/surveys/activate/:id

Parametry

brak

Przykładowa odpowiedź

{ "status":2 }

Zwracane błędy

  • 404 Not Found – Zasób nie został znaleziony lub nie istnieje.

  • 409 Conflict – Nie udało się zmienić statusu ankiety.

  • 500 Internal Server Error – Wewnętrzny błąd serwera.

Dezaktywacja ankiety

URL

(GET) https://www.webankieta.pl/api/v2/surveys/deactivate/:id

Parametry

brak

Przykładowa odpowiedź

{ "status":3 }

Zwracane błędy

  • 404 Not Found – Zasób nie został znaleziony lub nie istnieje.

Czy udało Ci się znaleźć odpowiedź na swoje pytanie?