Lista operacji dla zasobu

Nazwa

URL

Opis

Lista pytań

/questions/:id_survey/:id_page

Zwraca listę pytań dla ankiety o podanym ID.

Opis parametrów odpowiedzi

Nazwa/ścieżka

Opis

Możliwe wartości

id

ID pytania

id_page

ID strony na której znajduje się pytanie

number

Numer pytania

type

Typ pytania

0 – Jednokrotnego wyboru
1 – Macierzowe jednokrotne
2 – Opisowe
3 – Przydzielanie punktów
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 otwarte
19 – Przeciągnij i upuść

date_created

Data stworzenia pytania

date_modified

Data ostatniej edycji pytania

text

Treść pytania

desc

Opis pytania

required

Flaga informująca o tym, czy pytanie jest obowiązkowe

true – pytanie obowiązkowe
false – pytania nieobowiązkowe

answers_count

Ilość odpowiedzi w pytaniu

options.long_answer

Flaga informująca o tym czy w pytaniu opisowym powinna być miejsce na długi tekst odpowiedzi. Parametr widoczny tylko dla pytania opisowego

true – długi tekst odpowiedzi
false – krótki tekst odpowiedzi

options.min

W pytaniach wielokrotnego wyboru: minimalna liczba zaznaczonych odpowiedzi
W pytaniach o datę: najstarsza data do wyboru podczas wypełniania
W pytaniach o liczbę: minimalna możliwa wartości podczas wypełnianiaJeżeli wartość niezdefiniowana, wówczas zwrócony zostanienull

0 – liczba w podanym formacie
dd-mm-yyyy – data w podanym formacie
null – jeżeli wartość niezdefiniowana

options.max

W pytaniach wielokrotnego wyboru: maksymalna liczba zaznaczonych odpowiedzi
W pytaniach o datę: najmłodsza data do wyboru podczas wypełniania
W pytaniach o liczbę: maksymalna możliwa wartości podczas wypełnianiaJeżeli wartość niezdefiniowana, wówczas zwrócony zostanienull

0 – liczba w podanym formacie
dd-mm-yyyy – data w podanym formacie
null – jeżeli wartość niezdefiniowana

options.shuffle_answers

Flaga informująca o tym, czy kolejność wyświetlania odpowiedzi (kafeteria) powinna być wyświetlana w sposób losowy

Owe losowanie kolejności powinno się odbywać po stronie aplikacji klienta. Niezależnie od tej flagi API zawsze będzie zwracać te odpowiedzi w takiej samej kolejności.

Informacja dostępna dla pytań: jednokrotnego wyboru, wielokrotnego wyboru, macierzowego jednokrotnego wyboru, macierzowego wielokrotnego wyboru, rankingowego, formularza, suwakowego, listy rozwijalnej, przeciągnij i upuść

true – losowa kolejność wyświetlania odpowiedzi
false – ustalona kolejność wyświetlania odpowiedzi

options.horizintal_display

Flaga informująca o tym czy odpowiedzi powinny wyświetlane obok siebie (Pozioma orientacja wyświetlania odpowiedzi)

Informacja dostępna dla pytań: jednokrotnego wyboru i wielokrotnego wyboru.

true – pozioma orientacja wyświetlania odpowiedzi
false – pionowa orientacja wyświetlania odpowiedzi

options.range_positions_number

Liczba pozycji suwaka. Opcja dostępna tylko w pytaniu suwakowym.

answers.*

Odpowiedzi w pytaniu (kafeteria). Pole obezne w pytaniach: jednokrotnego wyboru, wielokrotnego wyboru, macierzowego jednokrotnego wyboru, macierzowego wielokrotnego wyboru, rankingowego, formularza, listy rozwijalnej, przeciągnij i upuść

Array

answers.text

Treśc odpowiedzi

answers.custom_response_available

Flaga informująca o tym, czy dla danej odpowiedzi jest możliwość udzielenia własnej odpowiedzi

true – własna odpowiedź dostępna
false – własna odpowiedź niedostępna

answers.required

Flaga informująca o tym, czy wypełnienie pola w odpowiedzi jest obowiązkowe. Parametr dostępny tylko dla pytania typu formularz

true – wypełnienie pola formularza obowiązkowe
false – wypełnienie pola formularza nie obowiązkowe

scales.*

Kolejne pozycje skali (ustalonej) dostępne dla pytaniach: macierzowego jednokrotnego wyboru, macierzowego wielokrotnego wyboru. macierzowego otwartego, przeciągnij i upuść

Array

scales.text

Treść etykiety skali

ranges.*

Skrajne etykiety skali płynnej, dostępne tylko dla pytania suwakowego

Array

ranges.left

Tekst po lewej stronie skali

ranges.right

Tekst po prawej stronie skali

Lista pytań

URL

(GET) https://www.webankieta.pl/api/v2/questions/:id_survey/:id_page

Parametry (GET)

Nazwa

Opis

id_survey

ID ankiety zawierającej pytania. Parametr obowiązkowy

id_page

ID strony zawierającej pytania. Strona musi należeć do ankiety (id_survey). Parametr opcjonalny

Przykładowa odpowiedź

[
{
"id":782299,
"id_page":258355,
"number":1,
"type":0,
"date_created":"2011-07-14 22:24:46",
"date_modified":"2011-12-29 18:04:24",
"text":"Jednokrotne",
"desc":"",
"required":1,
"answers_count":3,
"options":{
"shuffle_answers":false,
"horizontal_display":false
},
"answers":[
{
"text":"tak",
"custom_response_available":false
},
{
"text":"nie",
"custom_response_available":false
},
{
"text":"inne",
"custom_response_available":true
}
]
},
{
"id":782300,
"id_page":258355,
"number":2,
"type":6,
"date_created":"2011-07-14 22:24:58",
"date_modified":"2011-12-29 18:04:13",
"text":"Wielokrotne",
"desc":"",
"required":1,
"answers_count":4,
"options":{
"min":2,
"max":2,
"shuffle_answers":false,
"horizontal_display":false
},
"answers":[
{
"text":"tak",
"custom_response_available":false
},
{
"text":"nie",
"custom_response_available":false
},
{
"text":"mo\u017ce",
"custom_response_available":false
},
{
"text":"inne",
"custom_response_available":true
}
]
},
{
"id":782301,
"id_page":258355,
"number":3,
"type":1,
"date_created":"2011-07-14 22:25:10",
"date_modified":"2011-12-29 18:04:04",
"text":"macierzowe jednokrotne",
"desc":"",
"required":1,
"answers_count":2,
"options":{
"shuffle_answers":false
},
"answers":[
{
"text":"ola"
},
{
"text":"jola"
}
],
"scales":[
{
"text":"tak"
},
{
"text":"nie"
}
]
},{
"id":782302,
"id_page":258355,
"number":4,
"type":7,
"date_created":"2011-07-14 22:25:27",
"date_modified":"2011-12-29 18:03:54",
"text":"macierzowe wielokrotne",
"desc":"Podaj kolor oczu",
"required":1,
"answers_count":4,
"options":{
"shuffle_answers":false
},
"answers":[
{
"text":"ola"
},
{
"text":"jola"
},
{
"text":"ala"
},
{
"text":"zuza"
}
],
"scales":[
{
"text":"niebieski"
},
{
"text":"zielony"
},
{
"text":"piwny"
}
]
},
{
"id":782303,
"id_page":258355,
"number":5,
"type":2,
"date_created":"2011-07-14 22:25:36",
"date_modified":null,
"text":"otwarte",
"desc":"",
"required":1,
"answers_count":1,
"options":{
"long_answer":false
}
},
{
"id":782304,
"id_page":258355,
"number":6,
"type":5,
"date_created":"2011-07-14 22:25:52",
"date_modified":null,
"text":"Pytanie rankingowe",
"desc":"",
"required":1,
"answers_count":3,
"options":{
"shuffle_answers":true
},
"answers":[
{
"text":"jeden"
},
{
"text":"dwa"
},
{
"text":"trzy"
}
]
},
{
"id":782305,
"id_page":258355,
"number":7,
"type":4,
"date_created":"2011-07-14 22:26:04",
"date_modified":"2011-12-29 18:04:59",
"text":"Formularz",
"desc":"",
"required":0,
"answers_count":4,
"options":{
"shuffle_answers":false
},
"answers":[
{
"text":"Imi\u0119",
"required":false
},
{
"text":"Nazwisko",
"required":false
},
{
"text":"PESEL",
"required":true
},
{
"text":"Telefon",
"required":true
}
]
},
{
"id":782306,
"id_page":258355,
"number":8,
"type":8,
"date_created":"2011-07-14 22:26:27",
"date_modified":null,
"text":"Dyferencja\u0142",
"desc":"",
"required":1,
"answers_count":2,
"options":{
"shuffle_answers":false,
"range_positions_number":6
},
"ranges":[
{
"left":"\u017ale",
"right":"dobrze"
},
{
"left":"smutno",
"right":"weso\u0142o"
}
]
},
{
"id":819543,
"id_page":258355,
"number":9,
"type":13,
"date_created":"2011-12-29 16:56:00",
"date_modified":null,
"text":"Lista rozwijanla",
"desc":"",
"required":1,
"answers_count":4,
"options":{
"shuffle_answers":true
},
"answers":[
{
"text":"jeden"
},
{
"text":"dwa"
},
{
"text":"trzy"
},
{
"text":"cztery"
}
]
},
{
"id":819544,
"id_page":258355,
"number":10,
"type":10,
"date_created":"2011-12-29 16:57:27",
"date_modified":"2011-12-29 18:03:18",
"text":"Pytanie o liczb\u0119",
"desc":"Dodatkowy opis pytania o liczb\u0119",
"required":1,
"answers_count":1,
"options":{
"min":null,
"max":10
}
},
{
"id":819545,
"id_page":258355,
"number":11,
"type":11,
"date_created":"2011-12-29 16:57:48",
"date_modified":null,
"text":"Pytanie o e-mail",
"desc":"",
"required":1,
"answers_count":1
},
{
"id":819546,
"id_page":258355,
"number":12,
"type":12,
"date_created":"2011-12-29 16:58:07",
"date_modified":null,
"text":"Pytanie o dat\u0119",
"desc":"",
"required":1,
"answers_count":1,
"options":{
"min":"01-12-2011",
"max":"29-02-2012"
}
},
{
"id":1955652,
"id_page":258355,
"number":13,
"type":16,
"date_created":"2014-10-04 15:32:36",
"date_modified":"2014-10-17 16:36:39",
"text":"Na ile by\u0142by\u015b w stanie poleci\u0107 nasze us\u0142ugi swoim znajomym?",
"desc":"",
"required":1,
"answers_count":11,
"options":{
"left_scale":"Zdecydowanie nie polec\u0119",
"right_scale":"Zdecydowanie polec\u0119",
"justification":"Uzasadnij swoj\u0105 odpowied\u017a"
},
"answers":[
{
"text":"0",
"custom_response_available":true
},
{
"text":"1",
"custom_response_available":true
},
{
"text":"2",
"custom_response_available":true
},
{
"text":"3",
"custom_response_available":true
},
{
"text":"4",
"custom_response_available":true
},
{
"text":"5",
"custom_response_available":true
},
{
"text":"6",
"custom_response_available":true
},
{
"text":"7",
"custom_response_available":true
},
{
"text":"8",
"custom_response_available":true
},
{
"text":"9",
"custom_response_available":true
},
{
"text":"10",
"custom_response_available":true
}
]
},
{
"id":1955653,
"id_page":258355,
"number":14,
"type":19,
"date_created":"2011-07-14 22:25:10",
"date_modified":"2011-12-29 18:04:04",
"text":"przeciągnij i upuść",
"desc":"",
"required":1,
"answers_count":2,
"options":{
"shuffle_answers":false
},
"answers":[
{
"text":"morska kąpiel"
},
{
"text":"narty w górach"
}
],
"scales":[
{
"text":"lato"
},
{
"text":"zima"
}
]
},
]

Zwracane błędy

  • 400 Bad request – Niezgodne parametry, ankiecie o ID :id_survey nie ma strony o ID:id_page.

  • 401 Unauthorized – Użytkownik odwołuje się do obcego zasobu – ankiety, która nie jest jego własnością.

  • 404 Not Found – Nie znaleziono ankiety o podanym :id_survey.

  • 406 Not Acceptable – Nie przekazano parametru :id_survey.

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