- Payler

addItem
api/contactList/addItem
Добавление телефона в список
Аргументы
{
Id list-id id списка, в который добавляем
data
{
phone phoneТелефон
[sex] enum male\female || м\ж\хз || другой формат
[email] email
[любые другие данные, полезно для шаблонизации]
}
}
Ответ
{"error": false, "data": "item-id"}
Ошибки
Список не существует\нет прав
{"error": true, "data": "noSuchList"}
Очень странный телефон
{"error": true, "data": "incorrectPhone"}
create
api/contactList/create
Создание списка контактов
Аргументы
{
data
{
name text Название списка
}
}
Ответ
{"error": false, "data": "list-id"}
edit
api/contactList/edit
Редактирование списка
Аргументы
{
Data
{
Id list-id id списка
Name text название списка
[list] массив объектов телефонов Позволяет отредактировать\удалить много
телефонов одним запросом. Важно: поле id в случае создание списка телефонов
таким способом нужно генерировать самостоятельно.
}
}
Ответ
{"error": false, "data": "true"}
Ошибки
Список не существует\нет прав
{"error": true, "data": "noSuchList"}
editItem
api/contactList/editItem
Добавление телефона в список
Аргументы
{
Id list-id id списка, в котором редактируется запись
data
{
id item-id ID элемента списка
[любые новые данные] (произойдёт наложение на старые)
}
}
Ответ
{"error": false, "data": "item-id"}
Ошибки
Список не существует\нет прав
{"error": true, "data": "noSuchList"}
export
api/contactList/export
Экспорт списка
Аргументы
{
Id list-id id списка
Format text формат экспорта
}
Ответ
{"error": false, "data": "url - адрес для скачивания файла"}
get
api/contactList/get
Получить данные списка
Аргументы
{
Id list-id id списка
[full] boolean вернуть только список номеров (false [default]) или полный объект
списка (true)
}
Ответ
full = true
{
name: name,
list: [
{id: id, phone: phone, name: name},
...
]
}
full = false
[
{id: id, phone: phone, name: name},
...
]
Ошибки
Список не существует\нет прав
{"error": true, "data": "noSuchList"}
getItem
api/contactList/getItem
Получить данные контакта
Аргументы
{
Id list-id id списка, в котором редактируется запись
data
{
id item-id ID элемента списка
[любые данные для фильтрации. предпочтительноid]
}
}
list
api/contactList/list
Получить все доступные списки
Ответ
{"error": false, "data": [{length: n, id: id, name: name}, ...]}
remove
Удаление списка
api/contactList/remove
Аргументы
{
Id list-id id списка
}
Ответ
{"error": false, "data": "true"}
Ошибки
Список не существует\нет прав
{"error": true, "data": "noSuchList"}
removeItem
api/contactList/removeItem
Удаление телефона из списка
Аргументы
{
Id list-id id списка, в котором редактируется запись
data
{
id item-id ID элемента списка
}
}
Ответ
{"error": false, "data": "true"}
Ошибки
Список не существует\нет прав
{"error": true, "data": "noSuchList"}