Zoznam operácií pre zdroj
| Názov | URL | Popis |
|---|---|---|
| Zoznam kontakov | /contacts | Vracia zoznam kontaktov. Kontakty sú triedené abecedne podľa e-mailovej adresy. |
| Vyhľadávanie kontaktov | /contacts/search/:id_survey | Vyhľadáva kontakty podľa kritéria zadaného v POST tabuľke |
| Pridať kontakt | /contacts/add | Pridáva kontakt do zoznamu kontaktov prihláseného užívateľa |
| Pridať kontakt (vlastná distribúcia) | /contacts/add-offline | Pridá kontakt do zoznamu kontaktov (pre vlastné distribúciu sa nevyžaduje e-mailová adresa) |
| Zoznam skupín kontaktov | /contacts/group-list | Vracia zoznam skupín kontaktov používateľského účtu |
Opis parametrov odpovede
| Názov/cesta | Popis | Možné hodnoty |
|---|---|---|
id | ID kontaktu | |
email | E-mailová adresa | |
label1 | Hodnota prvého nepovinného štítku Aktívne štítok, ak bol definovaný v užívateľskom účte. | |
label2 | Hodnota druhého nepovinného štítku Aktívne štítok, ak bol definovaný v užívateľskom účte. | |
label3 | Hodnota tretieho nepovinného štítku Aktívne štítok, ak bol definovaný v užívateľskom účte. | |
label4 | Hodnota štvrtého nepovinného štítku Aktívne štítok, ak bol definovaný v užívateľskom účte. | |
label5 | Hodnota piateho nepovinného štítku Aktívne štítok, ak bol definovaný v užívateľskom účte. | |
| .. | … | |
| label15 | Hodnota pätnásteho nepovinného štítku Aktívne štítok, ak bol definovaný v užívateľskom účte. |
Zoznam kontaktov
URL
(GET) https://www.netquest.sk/api/contacts
Nepovinné parametre (POST)
| Názov | Popis |
|---|---|
id_group | ID skupiny kontaktov |
limit | Limit v počte vyplnení |
offset | Offset na zozname |
Ukážka odpovede
{
"total":"20",
"list":[{
"id":100824,
"email":"[email protected]",
"label1":"Petr",
"label2":"Novak",
"label3":"600 700 800",
"label4":"",
"label5":""
},{
...
}]
}
Chybové hlášky
401 Neautorizovaný – Užívateľ odkazuje na zdroj, ktorý nevlastní.
404 Nenájdené – Neboli nájdené skupina daného: id_group.
404 Not Found – Neboli nájdené žiadne kontakty.
Vyhľadávanie kontaktov
URL
(GET) https://www.netquest.sk/api/respondents/search
Nepovinné parametre (POST)
| Názov | Popis |
|---|---|
limit | Limit v počte vyplnení |
offset | Offset na zozname |
email | Vyhľadávanie respondenta podľa e-mailovej adresy |
label1 | Vyhľadávanie respondenta podľa hodnoty prvého štítku |
label2 | Vyhľadávanie respondenta podľa hodnoty druhého štítku |
label3 | Vyhľadávanie respondenta podľa hodnoty tretieho štítku |
label4 | Vyhľadávanie respondenta podľa hodnoty štvrtého štítku |
label5 | Vyhľadávanie respondenta podľa hodnoty piateho štítku |
| label15 | Vyhľadávanie respondenta podľa hodnoty pätnásteho štítku |
Ukážka odpovede
{
"total":"20",
"list":[{
"id":100824,
"email":"[email protected]",
"label1":"Petr",
"label2":"Novak",
"label3":"600 700 800",
"label4":"",
"label5":""
},{
...
}]
}
Chybové hlášky
401 Neautorizovaný – Užívateľ odkazuje na zdroj, ktorý nevlastní.
404 Nenájdené – Neboli nájdené žiadne kontakty.
Pridať kontakt
URL
(GET) https://www.netquest.sk/api/contacts/add
Parametre (POST)
| Názov | Popis |
|---|---|
email | E-mailová adresa (povinný parameter) |
id_group | ID skupiny, do ktorej bude kontakt pridaný. Nepovinný parameter. |
label1 | Hodnota prvého štítku |
label2 | Hodnota druhého štítku |
label3 | Hodnota tretieho štítku |
label4 | Hodnota štvrtého štítku |
label5 | Hodnota piateho štítku |
| label15 | Hodnota patnáctého štítku |
Ukážka odpovede
{
"id_contact":"149768"
}
Chybové hlášky
406 Neprijateľné - Neboli odovzdané žiadne povinné parametre.
Pridať kontakt (vlastné distribúcia, bez e-mailovej adresy)
URL
(GET) https://www.netquest.sk/api/contacts/add
Parametre (POST)
| Názov | Popis |
|---|---|
user_token | User token. Nepovinný parameter |
id_group | ID skupiny, do ktorej bude kontakt pridaný. Nepovinný parameter. |
label1 | Hodnota prvého štítku |
label2 | Hodnota druhého štítku |
label3 | Hodnota tretieho štítku |
label4 | Hodnota štvrtého štítku |
label5 | Hodnota piateho štítku |
| label15 | Hodnota patnáctého štítku |
Ukážka odpovede
{
"id_contact":"149768"
}
Chybové hlášky
406 Neprijateľné - Neboli odovzdané žiadne povinné parametre.
Zoznam skupín kontaktov
URL
(GET) https://www.netquest.sk/api/contacts/group-list
Ukážka odpovede
[
{
"id":9,
"name":"Zaměstnanci"
},
{
"id":15,
"name":"Klienti"
}
]
Chybové hlášky
Žiadne