Sprievodca - API

Kontakty

Zoznam operácií pre zdroj

NázovURLPopis
Zoznam kontakov/contactsVracia zoznam kontaktov. Kontakty sú triedené abecedne podľa e-mailovej adresy.
Vyhľadávanie kontaktov/contacts/search/:id_surveyVyhľadáva kontakty podľa kritéria zadaného v POST tabuľke
Pridať kontakt/contacts/addPridáva kontakt do zoznamu kontaktov prihláseného užívateľa
Pridať kontakt (vlastná distribúcia)/contacts/add-offlinePridá kontakt do zoznamu kontaktov (pre vlastné distribúciu sa nevyžaduje e-mailová adresa)
Zoznam skupín kontaktov/contacts/group-listVracia zoznam skupín kontaktov používateľského účtu

Opis parametrov odpovede

Názov/cestaPopisMožné hodnoty
idID kontaktu 
emailE-mailová adresa 
label1Hodnota prvého nepovinného štítku
Aktívne štítok, ak bol definovaný v užívateľskom účte.
 
label2Hodnota druhého nepovinného štítku
Aktívne štítok, ak bol definovaný v užívateľskom účte.
 
label3Hodnota tretieho nepovinného štítku
Aktívne štítok, ak bol definovaný v užívateľskom účte.
 
label4Hodnota štvrtého nepovinného štítku
Aktívne štítok, ak bol definovaný v užívateľskom účte.
 
label5Hodnota 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ázovPopis
id_groupID skupiny kontaktov
limitLimit v počte vyplnení
offsetOffset 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ázovPopis
limitLimit v počte vyplnení
offsetOffset na zozname
emailVyhľadávanie respondenta podľa e-mailovej adresy
label1Vyhľadávanie respondenta podľa hodnoty prvého štítku
label2Vyhľadávanie respondenta podľa hodnoty druhého štítku
label3Vyhľadávanie respondenta podľa hodnoty tretieho štítku
label4Vyhľadávanie respondenta podľa hodnoty štvrtého štítku
label5Vyhľ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ázovPopis
emailE-mailová adresa (povinný parameter)
id_groupID skupiny, do ktorej bude kontakt pridaný. Nepovinný parameter.
label1Hodnota prvého štítku
label2Hodnota druhého štítku
label3Hodnota tretieho štítku
label4Hodnota štvrtého štítku
label5Hodnota 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ázovPopis
user_tokenUser token. Nepovinný parameter
id_groupID skupiny, do ktorej bude kontakt pridaný. Nepovinný parameter.
label1Hodnota prvého štítku
label2Hodnota druhého štítku
label3Hodnota tretieho štítku
label4Hodnota štvrtého štítku
label5Hodnota 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

Pomohol Vám tento článok?

Ďakujeme za odpoveď