Průvodce - API

Kontakty

Seznam operací pro zdroj

NázevURLPopis
Seznam kontaktů/contactsVrací seznam kontaktů. Kontakty jsou tříděny abecedně podle e-mailové adresy.
Vyhledávání kontaktu/contacts/search/:id_surveyVyhledává kontakty podle kritéria zadaného v POST tabulce
Přidat kontakt/contacts/addPřidává kontakt do seznamu kontaktů přihlášeného uživatele
Přidat kontakt (vlastní distribuce)/contacts/add-offlinePřidá kontakt do seznamu kontaktů (pro vlastní distribuci se nevyžaduje e-mailová adresa)
Seznam skupin kontaktů/contacts/group-listVrací seznam skupin kontaktů uživatelského účtu

Popis parametrů odpovědi

Název/cestaPopisMožné hodnoty
idID kontaktu 
emailE-mailová adresa 
label1Hodnota prvního nepovinného štítku
Aktivní štítek, byl-li definován v uživatelském účtu.
 
label2Hodnota druhého nepovinného štítku
Aktivní štítek, byl-li definován v uživatelském účtu.
 
label3Hodnota třetího nepovinného štítku
Aktivní štítek, byl-li definován v uživatelském účtu.
 
label4Hodnota čtvrtého nepovinného štítku
Aktivní štítek, byl-li definován v uživatelském účtu.
 
label5Hodnota 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ázevPopis
id_groupID skupiny kontaktů
limitLimit v počtu vyplnění
offsetOffset na seznamu

Ukázka odpovědi

{
	"total":"20",
	"list":[{
		"id":100824,
		"email":"petr.novak@netquest.cz",
		"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ázevPopis
limitLimit v počtu vyplnění
offsetOffset na seznamu
emailVyhledávání respondenta podle e-mailové adresy
label1Vyhledávání respondenta podle hodnoty prvního štítku
label2Vyhledávání respondenta podle hodnoty druhého štítku
label3Vyhledávání respondenta podle hodnoty třetího štítku
label4Vyhledávání respondenta podle hodnoty čtvrtého štítku
label5Vyhledá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":"petr.novak@netquest.cz",
		"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ázevPopis
emailE-mailová adresa (povinný parametr)
id_groupID skupiny, do které bude kontakt přidán. Nepovinný parametr.
label1Hodnota prvního štítku
label2Hodnota druhého štítku
label3Hodnota třetího štítku
label4Hodnota čtvrtého štítku
label5Hodnota 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ázevPopis
user_tokenUser token. Nepovinný parametr
id_groupID skupiny, do které bude kontakt přidán. Nepovinný parametr.
label1Hodnota prvního štítku
label2Hodnota druhého štítku
label3Hodnota třetího štítku
label4Hodnota čtvrtého štítku
label5Hodnota 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é

Pomohl Vám tento článek?

Děkujeme za odpověď