Seznam operací pro zdroj
| Název | URL | Popis |
|---|---|---|
| Seznam kontaktů | /contacts | Vrací seznam kontaktů. Kontakty jsou tříděny abecedně podle e-mailové adresy. |
| Vyhledávání kontaktu | /contacts/search/:id_survey | Vyhledává kontakty podle kritéria zadaného v POST tabulce |
| Přidat kontakt | /contacts/add | Přidává kontakt do seznamu kontaktů přihlášeného uživatele |
| Přidat kontakt (vlastní distribuce) | /contacts/add-offline | Přidá kontakt do seznamu kontaktů (pro vlastní distribuci se nevyžaduje e-mailová adresa) |
| Seznam skupin kontaktů | /contacts/group-list | Vrací seznam skupin kontaktů uživatelského účtu |
Popis parametrů odpovědi
| Název/cesta | Popis | Možné hodnoty |
|---|---|---|
id | ID kontaktu | |
email | E-mailová adresa | |
label1 | Hodnota prvního nepovinného štítku Aktivní štítek, byl-li definován v uživatelském účtu. | |
label2 | Hodnota druhého nepovinného štítku Aktivní štítek, byl-li definován v uživatelském účtu. | |
label3 | Hodnota třetího nepovinného štítku Aktivní štítek, byl-li definován v uživatelském účtu. | |
label4 | Hodnota čtvrtého nepovinného štítku Aktivní štítek, byl-li definován v uživatelském účtu. | |
label5 | Hodnota pátého nepovinného štítku Aktivní štítek, byl-li definován v uživatelském účtu. | |
| .. | … | |
| label15 | Hodnota patnáctého nepovinného štítku Aktivní štítek, byl-li definován v uživatelském účtu. |
Seznam kontaktů
URL
(GET) https://www.netquest.cz/api/contacts
Nepovinné parametry (POST)
| Název | Popis |
|---|---|
id_group | ID skupiny kontaktů |
limit | Limit v počtu vyplnění |
offset | Offset na seznamu |
Ukázka odpovědi
{
"total":"20",
"list":[{
"id":100824,
"email":"[email protected]",
"label1":"Petr",
"label2":"Novak",
"label3":"600 700 800",
"label4":"",
"label5":""
},{
...
}]
}
Chybové hlášky
401 Neautorizováno– Uživatel odkazuje na zdroj, který nevlastní.404 Nenalezeno– Nebyla nalezena skupina daného:id_group.404 Not Found– Nebyly nalezeny žádné kontakty.
Vyhledávání kontaktů
URL
(GET) https://www.netquest.cz/api/respondents/search
Nepovinné parametry (POST)
| Název | Popis |
|---|---|
limit | Limit v počtu vyplnění |
offset | Offset na seznamu |
email | Vyhledávání respondenta podle e-mailové adresy |
label1 | Vyhledávání respondenta podle hodnoty prvního štítku |
label2 | Vyhledávání respondenta podle hodnoty druhého štítku |
label3 | Vyhledávání respondenta podle hodnoty třetího štítku |
label4 | Vyhledávání respondenta podle hodnoty čtvrtého štítku |
label5 | Vyhledávání respondenta podle hodnoty pátého štítku |
| label15 | Vyhledávání respondenta podle hodnoty patnáctého štítku |
Ukázka odpovědi
{
"total":"20",
"list":[{
"id":100824,
"email":"[email protected]",
"label1":"Petr",
"label2":"Novak",
"label3":"600 700 800",
"label4":"",
"label5":""
},{
...
}]
}
Chybové hlášky
401 Neautorizováno– Uživatel odkazuje na zdroj, který nevlastní.404 Nenalezeno– Nenalezeny žádné kontakty.
Přidat kontakt
URL
(GET) https://www.netquest.cz/api/contacts/add
Parametry (POST)
| Název | Popis |
|---|---|
email | E-mailová adresa (povinný parametr) |
id_group | ID skupiny, do které bude kontakt přidán. Nepovinný parametr. |
label1 | Hodnota prvního štítku |
label2 | Hodnota druhého štítku |
label3 | Hodnota třetího štítku |
label4 | Hodnota čtvrtého štítku |
label5 | Hodnota pátého štítku |
| label15 | Hodnota patnáctého štítku |
Ukázka odpovědi
{
"id_contact":"149768"
}
Chybové hlášky
406 Nepřijatelné– Nebyly předány žádné povinné parametry.
Přidat kontakt (vlastní distribuce, bez e-mailové adresy)
URL
(GET) https://www.netquest.cz/api/contacts/add
Parametry (POST)
| Název | Popis |
|---|---|
user_token | User token. Nepovinný parametr |
id_group | ID skupiny, do které bude kontakt přidán. Nepovinný parametr. |
label1 | Hodnota prvního štítku |
label2 | Hodnota druhého štítku |
label3 | Hodnota třetího štítku |
label4 | Hodnota čtvrtého štítku |
label5 | Hodnota pátého štítku |
| label15 | Hodnota patnáctého štítku |
Ukázka odpovědi
{
"id_contact":"149768"
}
Chybové hlášky
406 Nepřijatelné– Nebyly předány žádné povinné parametry.
Seznam skupin kontaktů
URL
(GET) https://www.netquest.cz/api/contacts/group-list
Ukázka odpovědi
[
{
"id":9,
"name":"Zaměstnanci"
},
{
"id":15,
"name":"Klienti"
}
]
Chybové hlášky
Žádné