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/:id_survey

Wyszukuje kontakty wg. kryteriów przekazanych w tablicyPOST

Dodanie kontaku

/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)

Lista grup kontaktów

/contacts/group-list

Zwraca listę grup kontaktów na koncie użytkownika.

Opis parametrów odpowiedzi

Nazwa/ścieżka

Opis

Możliwe wartości

id

ID kontaktu

email

Adres e-mail

label1

Wartość pierwszej opcjonalnej etykiety. Etykieta aktywna, jeśli została zdefiniowana na koncie użytkownika.

label2

Wartość drugiej opcjonalnej etykiety. Etykieta aktywna, jeśli została zdefiniowana na koncie użytkownika.

label3

Wartość trzeciej opcjonalnej etykiety. Etykieta aktywna, jeśli została zdefiniowana na koncie użytkownika.

label4

Wartość czwartej opcjonalnej etykiety. Etykieta aktywna, jeśli została zdefiniowana na koncie użytkownika.

label5

Wartość piątej opcjonalnej etykiety. Etykieta aktywna, jeśli została zdefiniowana na koncie użytkownika.

Lista kontaktów

URL

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

Parametry opcjonalne (POST)

Nazwa

Opis

id_group

ID grupy kontaktów

limit

Limit na liczbę wypełnień

offset

Offset na listę

Przykładowa odpowiedź

{
"total":"20",
"list":[{
"id":100824,
"email":"jan@kowalski.pl",
"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 grupy o podanym :id_group.

  • 404 Not Found – Jeżeli nie znaleziono kontaktów.

Wyszukiwanie kontaktów

URL

(GET) https://www.webankieta.pl/api/v2/respondents/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 etykiety 1

label2

Wyszukiwanie respondenta po wartości etykiety 2

label3

Wyszukiwanie respondenta po wartości etykiety 3

label4

Wyszukiwanie respondenta po wartości etykiety 4

label5

Wyszukiwanie respondenta po wartości etykiety 5

Przykładowa odpowiedź

{
"total":"20",
"list":[{
"id":100824,
"email":"jan@kowalski.pl",
"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.

Dodawanie kontaktów

URL

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

Parametry (POST)

Nazwa

Opis

email

Adres e-mail (parametr obowiązkowy)

id_group

ID grupy, do której zostanie kontakt. Parametr opcjonalny.

label1

Wartość etykiety 1

label2

Wartość etykiety 2

label3

Wartość etykiety 3

label4

Wartość etykiety 4

label5

Wartość etykiety 5

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)

id_group

ID grupy, do której zostanie kontakt. Parametr opcjonalny.

label1

Wartość etykiety 1

label2

Wartość etykiety 2

label3

Wartość etykiety 3

label4

Wartość etykiety 4

label5

Wartość etykiety 5

Przykładowa odpowiedź

{ 
"id_contact":"149768"
}

Zwracane błędy

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

Lista grup kontaktów

URL

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

Przykładowa odpowiedź

[
{
"id":9,
"name":"Pracownicy"
},
{
"id":15,
"name":"Klienci"
}
]

Zwracane błędy

Brak

Czy udało Ci się znaleźć odpowiedź na swoje pytanie?