Pruvodce - API

Otázky

Seznam operací pro zdroj

NázevURLPopis
Seznam otázek/questions/:id_survey/:id_pageVrací seznam otázek pro dotazník daného ID.

Popis parametrů odpovědi

Název/cestaPopisMožné hodnoty
idID otázky 
id_pageID stránky s otázkou 
numberČíslo otázky 
typeTyp otázky0 – Otázka s jednou možností výběru
1 – Maticová otázka s jednou možností výběru
2 – Popis
4 – Formulář
5 – Rankingová otázka
6 – Otázka s více možnostmi výběru
7 – Maticová otázka s více možnostmi výběru
8 – Otázka s posuvníkem (stupnice)
9 – Otevřená otázka
10 – Numerická otázka
11 – Otázka na e-mailovou adresu
12 – Datumová otázka
13 – Roletka
14 – Klauzule pro sběr osob. údajů
15 – Nahrát soubor
16 – NPS
17 – Otevřená maticová otázka
19 – Otázka uchopit a přesunout
date_createdDatum vytvoření otázky 
date_modifiedDatum poslední editace otázky 
textObsah otázky 
descPopis otázky 
requiredPříznak označující jestli je otázka povinná nebo netrue – Povinná otázka
false – Nepovinná otázka
answers_countPočet odpovědí v otázce 
options.long_answerPříznak, označující jestli by popisová otázka měla mít místo pro delší text odpovědi, nebo ne.

Parametr je viditelný pouze pro popisové otázky
true – Dlouhý text odpovědi
false – Krátký text odpovědi
options.minV otázkách s více možnostmi výběru: minimální počet vybraných odpovědí
V otázkách na datum: nejvzdálenější možné datum k výběru při vyplňování
V otázkách na číslo: minimální možná hodnota při vyplňování  

Není-li hodnota definována, bude vráceno null

0 – Číslo v daném formátu
dd-mm-yyyy – Datum v daném formátu
null – Není-li hodnota definována
options.maxV otázkách s více možnostmi výběru: maximální počet vybraných odpovědí
V otázkách na datum: nejbližší možné datum k výběru při vyplňování
V otázkách na číslo: maximální možná hodnota při vyplňování 

Není-li hodnota definována, bude vráceno null

0 – Číslo v daném formátu
dd-mm-yyyy – Datum v daném formátu
null – Není-li hodnota definována
options.shuffle_answersPříznak, označující jestli má být pořadí odpovědí náhodné.

Tato náhodná prezentace by měla být vykonána na straně aplikace klienta.



Nehledě na tento příznak, API bude vždy vracet odpovědi ve stejném pořadí. Informace dostupné pro následující otázky: Otázka s jednou možností výběru, Otázka s více možnostmi výběru, Maticová otázka s jednou možností výběru, Maticová otázka s více možnostmi výběru, Rankingová otázka, Formulář, Otázka s posuvníkem (stupnice), Roletka, Otázka uchopit a přesunout

true – Náhodné pořadí odpovědí
false – Nastavení pořadí odpovědí
options.horizontal_displayPříznak, označující jestli mají být odpovědi zobrazené vedle sebe (horizontální orientace odpovědí)

Informace dostupné pro následující otázky: Otázka s jednou možností výběru a Otázka s více možnostmi výběru.

true – Horizontální orientace odpovědí
false – Vertikální orientace odpovědí
options.range_positions_numberPočet pozic posuvníku. Tato možnost je dostupná pouze pro otázky s posuvníkem. 
answers.*Odpovědi v otázce. Pole je dostupné pro následující otázky:
Otázka s jednou možností výběru, Otázka s více možnostmi výběru, Maticová otázka s jednou možností výběru, Maticová otázka s více možnostmi výběru, Rankingová otázka, Formulář, Roletka, Otázka uchopit a přesunout
Array
answers.textObsah odpovědi 
answers.custom_response_availablePříznak, označující jestli může být odpověď i „uživatelská”true – Uživatelská odpověď dostupná
false – Uživatelská odpověď nedostupná
answers.requiredPříznak, označující jestli je nebo není vyplnění odpovědi povinné.
Parametr je dostupný pro formulář.
true – Vyplnění pole formuláře je povinné
false – Vyplnění pole formuláře je nepovinné
scales.*Následující polohy měřítka (nastavení rozsahu) jsou k dispozici v následujících otázkách:
Maticová otázka s jednou možností výběru, Maticová otázka s více možnostmi výběru, Otázka uchopit a přesunout
Array
scales.textObsah štítku měřítka 
ranges.*Krajní štítky z měřítka jsou povoleny pouze pro otázku se stupnici (posuvníkem)Array
ranges.leftText na levé straně od stupnice 
ranges.rightText na pravé straně od stupnice 

Seznam otázek

URL

(GET) https://www.netquest.cz/api/questions/:id_survey/:id_page

Parametry (GET)

NázevPopis
id_surveyID dotazníku obsahující otázky. Povinný parametr
id_pageID stránky obsahující otázky. Stránka musí spadat pod dotazník (id_survey). Nepovinný parametr

Ukázka odpovědi

[
  {
    "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":"Otázka s jednou možností výběru",
    "desc":"",
    "required":1,
    "answers_count":3,
    "options":{
    "shuffle_answers":false,
    "horizontal_display":false
    },
    "answers":[
      {
        "text":"Ano",
        "custom_response_available":false
      },
      {
        "text":"Ne",
        "custom_response_available":false
      },
      {
        "text":"Jiné",
        "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":"Otázka s více možnostmi výběru",
    "desc":"",
    "required":1,
    "answers_count":4,
    "options":{
    "min":2,
    "max":2,
    "shuffle_answers":false,
    "horizontal_display":false
    },
    "answers":[
      {
        "text":"Ano",
        "custom_response_available":false
      },
      {
        "text":"Ne",
        "custom_response_available":false
      },
      {
        "text":"Možná",
        "custom_response_available":false
      },
      {
        "text":"Jiné",
        "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":"Maticová otázka s jednou možností výběru",
    "desc":"",
    "required":1,
    "answers_count":2,
    "options":{
    "shuffle_answers":false
    },
    "answers":[
      {
        "text":"Ola"
      },
      {
        "text":"Jola"
      }
    ],
    "scales":[
      {
        "text":"Ano"
      },
      {
        "text":"Ne"
      }
    ]
  },
  {
    "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":"Maticová otázka s více možnostmi výběru",
    "desc":"Zadejte barvu očí",
    "required":1,
    "answers_count":4,
    "options":{
    "shuffle_answers":false
    },
    "answers":[
      {
        "text":"Jana"
      },
      {
        "text":"Petra"
      },
      {
        "text":"Alena"
      },
      {
        "text":"Zuzka"
      }
    ],
    "scales":[
      {
        "text":"Modré"
      },
      {
        "text":"Zelené"
      },
      {
        "text":"Hnědé"
      }
    ]
  },
  {
    "id":782303,
    "id_page":258355,
    "number":5,
    "type":2,
    "date_created":"2011-07-14 22:25:36",
    "date_modified":null,
    "text":"Otevřená otázka",
    "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":"Rankingová otázka",
    "desc":"",
    "required":1,
    "answers_count":3,
    "options":{
    "shuffle_answers":true
    },
    "answers":[
      {
        "text":"Jedna"
      },
      {
        "text":"Dva"
      },
      {
        "text":"Tři"
      }
    ]
  },
  {
    "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":"Formulář",
    "desc":"",
    "required":0,
    "answers_count":4,
    "options":{
    "shuffle_answers":false
    },
    "answers":[
      {
        "text":"Jméno",
        "required":false
      },
      {
        "text":"Příjmení",
        "required":false
      },
      {
        "text":"Číslo",
        "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":"Posuvníková otázka",
    "desc":"",
    "required":1,
    "answers_count":2,
    "options":{
    "shuffle_answers":false,
    "range_positions_number":6
    },
    "ranges":[
      {
        "left":"Špatné",
        "right":"Dobré"
      },
      {
        "left":"Smutné",
        "right":"Štastné"
      }
    ]
  },
  {
    "id":819543,
    "id_page":258355,
    "number":9,
    "type":13,
    "date_created":"2011-12-29 16:56:00",
    "date_modified":null,
    "text":"Roletka",
    "desc":"",
    "required":1,
    "answers_count":4,
    "options":{
    "shuffle_answers":true
    },
    "answers":[
      {
        "text":"Jedna"
      },
      {
        "text":"Dva"
      },
      {
        "text":"Tři"
      },
      {
        "text":"Čtyři"
      }
    ]
  },
  {
    "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":"Numerická otázka",
    "desc":"Dodatečný popis",
    "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":"Otázka na e-mailovou adresu",
    "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":"Datumová otázka",
    "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":"NPS otázka",     
    "desc":"",     
    "required":1,     
    "answers_count":11,     
    "options":{       
    "left_scale":"Určitě ne",       
    "right_scale":"Určitě ano",       
    "justification":"Prosím zdůvodněte svoji odpověď"     
     },     "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":"Otázka uchopit a přesunout",     
        "desc":"",     
        "required":1,     
        "answers_count":2,     
        "options":{       
          "shuffle_answers":false     
         },     
         "answers":[       
           {         
             "text":"Mořská koupel"       
           },       
           {          
             "text":"Lyžování na horách"       
           }     
         ],     
         "scales":[       
           {         
             "text":"Léto"       
           },       
           {         
             "text":"Zima"       
        }     
      ]   
   }, 
] 

Chybové hlášky

  • 400 Špatný požadavek – Nekompatibilní parametry, není zde žádná stránka s ID:id_page v dotazníku s ID :id_survey.
  • 401 Neautorizováno – Uživatel odkázán na zdroj – dotazník – kterou nevlastní.
  • 404 Nenalezeno – Nebyl nalezen žádný dotazník daného :id_survey.
  • 406 Nepřijatelné – Nebyl předán žádný parametr :id_survey.

Pomohl Vám tento článek?

Děkujeme za odpověď