Lista operacji dla zasobu

Nazwa

URL

Opis

Rozpoczęcie wypełniania

/responses/getaccess
/:id_survey

Przed odpowiedzią na jakiekolwiek pytanie, należy uzyskać dostęp do kwestionariusza ankiety. Jest to niezbędne jeśli dostęp do ankiety wymaga hasła, hasła jednorazowego, lub ankieta ma ograniczoną ważność. Jeśli ankieta jest dostępna dla respondenta w odpowiedzi zwróci jednorazowy klucz, który będzie identyfikował respondenta przy wypełnianiu kolejnych stron i pytań.

Udzielanie odpowiedzi na pytania

/responses/answer
/:id_survey/:id_response

Operacja służy do udzielenia odpowiedzi na wszystkie pytania znajdujące się w zakresie strony. Pod ten adres należy wysłać odpowiednio skonstruowane parametry POST – odpowiednia konstrukcja dla wszystkich rodzajów pytań. Jeżeli odpowiedzi będą poprawne w odpowiedzi zostanie zwrócone ID strony, którą należy wypełnić jako następną. Wynik operacji uwzględnia przejścia pomiędzy stronami w zależności od udzielonej odpowiedzi.

Ustalenie czasu wypełniania

/responses/settime
/:id_survey/:id_response

Jeżeli wypełnienia ankiety są wykonywane na urządzeniu mobilnym w wersji offline, nie ma możliwości aby API poprawnie obliczyło czas wypełniania. Dlatego musi istnieć operacja, która pozwoli na dostarczenie daty rozpoczęcia i zakończenia wypełniania.

Opis parametrów odpowiedzi

Nazwa/ścieżka

Opis

Możliwe wartości

id_response

ID wypełnienia używane do wypełniania wielostronicowych kwestionariuszy. Używane wspólnie z parametrem respondent_key

respondent_key

Klucz identyfikujący wypełnienie i respondenta Za pomocą tego parametru system waliduje dostęp do ankiety oraz poprawną kolejność wypełnianych stron.

id_next_page

ID strony, która musi być wypełniona jako następna

acknowledgments

Treść podziękowania za wypełnienie ankiety

veryfication_code

Kod weryfikacyjny, zwracany, jeśli w ankiecie włączono opcję „Generowanie unikalnego kodu po wypełnieniu ankiety”

error_code

Kod odpowiedzi jeśli dostęp do kwestionariusza kończy się niepowodzeniem

1 – badanie nieaktywne
2 – badanie zakończone
3 – niepoprawna wartość parametruurl_title
4 – niepoprawne wartość parametrupassword
5 – niepoprawna wartość parametrutoken
6 – token wykorzystany wcześniej
7 – niepoprawny klucz respondenta (:respondent_key)
8 – nie odpowiedziano na wszystkie pytania obowiązkowe
9 – nieprawidłowy typ pytania
10 – nieprawidłowa kolejność udzielania odpowiedzi. Niepoprawna wartość parametru id_page
11 – respondent zakończył już wypełnianie ankiety

Rozpoczęcie wypełniania

URL

(POST) https://www.webankieta.pl/api/responses/getaccess

Parametry (GET)

Nazwa

Opis

id_survey

ID ankiety. Parametr obowiązkowy

Parametry (POST)

Nazwa

Opis

url_title

Parametr wymagany w ankietach o średnim poziomie bezpieczeństwa. Wartością parametru jest tytuł ankiety zawarty w linku do ankiety. Parametr url_title jest zwracany w operacji Informacje o ankiecie

password

Parametr wymagany w ankietach o wysokim poziomie bezpieczeństwa. Hasło jest wymagane do uzyskania dostępu do ankiety. Hasło jest jednakowe dla wszystkich respondentów.

token

Parametr wymagany w ankietach o najwyższym poziomie bezpieczeństwa. Token jest wymagany do uzyskania dostępu do ankiety. Token jest jednorazowym hasłem identyfikującym respondenta.

Przykładowa odpowiedź

{
"id_next_page":269666,
"id_response":5902271,
"respondent_key":"78a37f13bf9afc471151994a4f47f29a"
}

Zwracane błędy

  • 404 Not Found – Ankieta nie istnieje.

  • 406 Not Acceptable – Nie przekazano obowiązkowych parametrów.

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

Udzielanie odpowiedzi na pytania

URL

(GET) https://www.webankieta.pl/api/responses/answer

Parametry (GET)

Nazwa

Opis

id_survey

ID ankiety. Parametr obowiązkowy

id_response

ID wypełniania. Parametr obowiązkowy. ID jest zwracane przez operację /responses/getaccess

Parametry (POST)

Parametry POST różnią się w zależności od typu pytania na które udzielana jest odpowiedź.
Poniżej paramtery POST różnią się w zależności od przekazanego typu pytania.

Nazwa

Opis

respondent_key

Klucz weryfikujący respondenta. Klucz jest zwracany przez operację/responses/getaccess

id_page

ID strony, którą wypełnia respondent

questions[:id_question][type]

Typ pytania przekazywany jako integer. Można przekazać wartości od 0 do 13

Blok opisowy

Nazwa

Wartość

Opis

questions[:id_question][type]

9

Wartość parametru dla bloku opisowego

Pytanie jednokrotnego wyboru

Nazwa

Wartość

Opis

questions[:id_question][type]

0

Wartość parametru dla pytania jednokrotnego wyboru

questions[:id_question][answer]

:answer_number

Numer odpowiedzi na pytanie. Odpowiedzi numerowane są od 1 do 60

questions[:id_question][other_answer][:answer_number]

string

Odpowiedź na pytanie wprowadzona przez respondenta w pole tekstowe. Ten parametr jest przekazywany dla odpowiedzi, w których jest włączona możliwość wpisania własnej odpowiedzi przez respondenta.

Pytanie wielokrotnego wyboru

Nazwa

Wartość

Opis

questions[:id_question][type]

6

Wartość parametru dla pytania wielokrotnego wyboru

questions[:id_question][answers][:answer_number]

true

Flaga informująca o tym, że odpowiedź o podanym :anser_number została zaznaczona przez respondenta

questions[:id_question][other_answers][:answer_number]

string

Odpowiedź własna respondenta. Ten parametr jest przekazywany dla odpowiedzi, w których jest włączona możliwość wpisania własnej odpowiedzi przez respondenta.

Pytanie macierzowe jednokrotnego wyboru

Nazwa

Wartość

Opis

questions[:id_question][type]

1

Wartość parametru dla pytania macierzowego jednokrotnego wyboru

questions[:id_question][answers][:answer_number]

:scale_number

W odpowiedzi o numerze :answer_number (numerowane od 1 do 60) ze skali respondent wybrał pozycję numer :scale_number(numerowane od 1 do 15)

Pytanie macierzowe wielokrotnego wyboru

Nazwa

Wartość

Opis

questions[:id_question][type]

7

Wartość parametru dla pytania macierzowego wielokrotnego wyboru

questions[:id_question][answers][:answer_number][:scale_number]

true

Flaga informująca, że w odpowiedzi o numerze :answer_number(numerowane od 1 do 60) respondent zaznaczył pole w kolumnie o numerze:scale_number (numerowane od 1 do 15)

Pytanie opisowe

Nazwa

Wartość

Opis

questions[:id_question][type]

2

Wartość parametru dla pytania opisowego

questions[:id_question][answers][]

string

Odpowiedź opisowa wpisana, przez respondenta. Tablica z odpowiedziami posiada tyle elementów, ile pól do wprowadzenia odpowiedzi posiada pytanie opisowe.

Przydzielanie punktów

Nazwa

Wartość

Opis

questions[:id_question][type]

3

Wartość parametru dla pytania z przydzielaniem punktów

questions[:id_question][answers][:answer_number]

:points_amount

Odpowiedzi o numerze :answer_number (numerowana od 1 do 60) została przydzielona libcza punktów :points_amount

Pytanie rankingowe

Nazwa

Wartość

Opis

questions[:id_question][type]

5

Wartość parametru dla pytania rankingowego

questions[:id_question][answers][:answer_number]

:position_number

Odpowiedź o numerze :answer_number (numerowana od 1 do 15) została umieszczona na pozycji :position_number(numerowanej od 1 do 15)

Lista rozwijalna

Nazwa

Wartość

Opis

questions[:id_question][type]

13

Wartość parametru dla listy rozwijalnej

questions[:id_question][answer]

:answer_number

Respondent wybrał z listy rozwijalnej odpowiedź na pozycji:answer_number (numerowaną od 1 do 60)

Formularz

Nazwa

Wartość

Opis

questions[:id_question][type]

4

Wartość parametru dla formularza

questions[:id_question][answers][:answer_numer]

string

W polu o numerze :answer_numer (numerowane od 1 do 60) respondent wpisał swoją odpowiedź w formie napisu (string)

Pytanie suwakowe

Nazwa

Wartość

Opis

questions[:id_question][type]

8

Wartość parametru dla pytania suwakowego

questions[:id_question][answers][:answer_number]

int_value

W odpowiedzi (suwaku) o numerze :answer_number (numerowanych od 1 do 15) respondent ustawił wartość int_value (przyjmująca wartości od 1 do 100).

Pytanie o liczbę

Nazwa

Wartość

Opis

questions[:id_question][type]

10

Wartość parametru dla pytania o liczbę

questions[:id_question][answer]

int_value

Respondent udzielił odpowiedzi o wartości int_value

Pytanie o e-mail

Nazwa

Wartość

Opis

questions[:id_question][type]

11

Wartość parametru dla pytania o e-mail

questions[:id_question][answer]

string

Respondent udzielił odpowiedzi o wartości string

Pytanie o datę

Nazwa

Wartość

Opis

questions[:id_question][type]

12

Wartość parametru dla pytania o datę

questions[:id_question][answer]

string

Respondent udzielił odpowiedzi na pytanie o wartości string w formaciedd-mm-yyyy

Klauzula GIODO

Nazwa

Wartość

Opis

questions[1][type]

14

Wartość parametru dla klauzuli GIODO

questions[1][answer]

true

Flaga informująca o tym, że respondent wraził zgodę na przetwarzanie danych osobowych

Upload pliku

Brak możliwości wypełnienia tego typu pytania przez API

NPS

Nazwa

Wartość

Opis

questions[:id_question][type]

16

Wartość parametru dla pytania NPS

questions[:id_question][answer]

:answer_number

Numer odpowiedzi na pytanie. Odpowiedzi numerowane są od 1 do 11

questions[:id_question][other_answer][:answer_number]

string

Odpowiedź na pytanie wprowadzona przez respondenta jako uzasadnienie wyboru. Ten parametr jest przekazywany dla odpowiedzi, w których jest włączona możliwość wpisania uzasadnienie przez respondenta.

Macierzowe otwarte

Nazwa

Wartość

Opis

questions[:id_question][type]

17

Wartość parametru dla pytania macierzowego otwartego

questions[:id_question][answers][:answer_number][:scale_number]

string

Odpowiedż otwarta wpisana dla danego wiersza i kolumny

Pytanie przeciągnij i upuść

Nazwa

Wartość

Opis

questions[:id_question][type]

19

Wartość parametru dla pytania przeciągnij i upuść

questions[:id_question][answers][:answer_number]

:scale_number

Odpowiedzi o numerze :answer_number (numerowane od 1 do 100) została przyporządkowana do grupy numer :scale_number(numerowane od 1 do 15)

Przykładowa odpowiedź

{ 
"id_next_page":269666,
}

Przykładowa odpowiedź II

{ 
"acknowledgments":"Dzi\u0119kujemy za wype\u0142nienie ankiety", "veryfication_code":"838882"
}

Zwracane błędy

  • 404 Not Found – Ankieta nie istnieje.

  • 406 Not Acceptable – Nie przekazano obowiązkowych parametrów.

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

Ustalenie czasu wypełniania

URL

(POST) https://www.webankieta.pl/api/responses/settime

Parametry (GET)

Nazwa

Opis

id_survey

ID ankiety. Parametr obowiązkowy

id_response

ID wypełnienia. Parametr obowiązkowy. ID jest zwracane przez operację /responses/getaccess

Parametry (POST)

Nazwa

Opis

respondent_key

Klucz weryfikujący respondenta. Klucz jest zwracany przez operację /responses/getaccess

date_survey_open

Parametr obowiązkowy. Data i godzina pierwszego otwarcia ankiety. Format daty to: 2012-12-06 12:00:00.

date_survey_answer

Parametr obowiązkowy. Data i godzina wypełnienia ankiety. Format daty to: 2012-12-06 12:00:00.

Przykładowa odpowiedź

{ 
"confirmation":true
}

Zwracane błędy

  • 400 Bad request – Nieprawidłowy format daty.

  • 404 Not Found – Ankieta nie istnieje.

  • 406 Not Acceptable – Nie przekazano obowiązkowych parametrów.

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

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