Kontakty

Kontakt to rekord w bazie użytkownika, który zawiera co najmniej adres e-mail i nie jest powiązany z żadną ankietą na koncie.

Aby dodać respondenta do ankiety, należy stworzyć kontakt. Kontakt to powiązanie encji respondenta z ankietą.

Zarówno kontakty jak i respondenci nie muszą być unikalne w ramach konta użytkownika.

Operacje na respondentach znajdują się w następnej sekcji o nazwie Respondenci

Lista operacji dla zasobu

Nazwa	URL	Opis
Lista kontaktów	`/contacts`	Zwraca listę kontaktow. Kontakty posortowane są wg. adresu email w kolejności alfabetycznej.
Wyszukiwanie kontaków	`/contacts/search`	Wyszukuje kontakty wg. kryteriów przekazanych w tablicy`POST`
Dodanie kontaktu	`/contacts/add`	Dodaje kontakt do listy kontaktów zalogowanego użytkownika
Dodanie kontaku (dystrybucja offline)	`/contacts/add-offline`	Dodaje kontakt do listy kontaktów (dla dystrybucji offline, email nie jest wymagany)

Opis parametrów odpowiedzi

Nazwa/ścieżka	Opis	Możliwe wartości
`id`	ID kontaktu
`email`	Adres e-mail
`label1`	Wartość pierwszego opcjonalnego atrybutu. Atrybut jest aktywny, jeśli został zdefiniowany na koncie użytkownika.
`label2` ....`label15`	Wartość kolejnych opcjonalnych atrybutów (od 2 do 15). Atrybut aktywny, jeśli został zdefiniowany na koncie użytkownika.

Lista kontaktów

URL

(GET) https://www.webankieta.pl/api/v2/contacts

Parametry opcjonalne (POST)

Nazwa	Opis
`limit`	Limit na liczbę wypełnień
`offset`	Offset na listę

Przykładowa odpowiedź

{
	"total":"20",
	"list":[{
		"id":100824,
		"email":"[email protected]",
		"label1":"Jan",
		"label2":"Kowalski",
		"label3":"600 700 800",
		"label4":"",
		"label5":""
	},{
		...
	}]
}

Zwracane błędy

401 Unauthorized – Jeżeli użytkownik odwołuje się do obcego zasobu.
404 Not Found – Jeżeli nie znaleziono kontaktów.

Wyszukiwanie kontaktów

URL

(GET) https://www.webankieta.pl/api/v2/contacts/search

Parametry opcjonalne (POST)

Nazwa	Opis
`limit`	Limit na liczbę wypełnień
`offset`	Offset na listę
`email`	Wyszukiwanie respondenta po adresie email
`label1`	Wyszukiwanie respondenta po wartości atrybutu 1
`labeln`	Wyszukiwanie respondenta po wartości atrybutu n

Przykładowa odpowiedź

{
	"total":"20",
	"list":[{
		"id":100824,
		"email":"[email protected]",
		"label1":"Jan",
		"label2":"Kowalski",
		"label3":"600 700 800",
		"label4":"",
		"label5":""
	},{
		...
	}]
}

Zwracane błędy

401 Unauthorized – Jeżeli użytkownik odwołuje się do obcego zasobu.

Dodawanie kontaktów

URL

(GET) https://www.webankieta.pl/api/v2/contacts/add

Parametry (POST)

Nazwa	Opis
`email`	Adres e-mail (parametr obowiązkowy)
`label1`	Wartość atrybutu 1
`labeln`	Wartość atrybutu n

Przykładowa odpowiedź

{ 
"id_contact":"149768" 
}

Zwracane błędy

406 Not Acceptable – Jeżeli nie przekazano obowiązkowych parametrów.

Dodawanie kontaktów offline (bez adresu e-mail)

URL

(GET) https://www.webankieta.pl/api/v2/contacts/add

Parametry (POST)

Nazwa	Opis
`user_token`	User token (parametr obowiązkowy)
`label1`	Wartość atrybutu 1
`labeln`	Wartość atrybutu n

Przykładowa odpowiedź

{ 
"id_contact":"149768" 
}

Zwracane błędy

406 Not Acceptable – Jeżeli nie przekazano obowiązkowych parametrów.