Контакты и сотрудники

Данные пользователя хранятся в следующих таблицах:

• USAM_TABLE_CONTACTS — основная таблица
• USAM_TABLE_CONTACT_META — дополнительная таблица, данные хранятся по принципу ключ — значение

В таблице USAM_TABLE_CONTACTS хранятся

• id — номер пользователя
• total_purchased — всего куплено
• last_order_date — дата последнего заказа
• number_orders — количество заказов
• appeal — отображаемое имя
• online — дата и время последнего посещения сайта
• company_id — id компании в которой работает
• manager_id — ответственный менеджер
• date_insert — дата добавления пользователя в базу

Все остальные данные храниться в таблице USAM_TABLE_CONTACT_META по принципу ключ — значение.

Получить контакты

Путь: /wp-json/usam/v1/contacts

Метод запроса: GET

• status — массив или строка, статус контакта(не обязательный);
• status__not_in — массив или строка, исключить контакты со статусом указанным в параметре(не обязательный);
• source — массив или строка, источник контакта, например, employee — сотрудники(не обязательный);
• source__not_in — массив или строка, исключить контакты с указанным источником в параметре(не обязательный);
• search — строка, поиск по номеру, имени, телефону, электронной почте (не обязательный);
• count — число, количество в одном запросе, по умолчанию 10 (не обязательный);
• paged — число, страница списка (не обязательный);
• fields — в каком виде предоставить данные(не обязательный).
• add_fields — массив, какие дополнительны данные вернуть(не обязательный).

Дополнительные данны, которые можно указать в параметре add_fields

• foto — ссылка на фотографию
• manager — менеджер
• post — должность в компании
• source — источник
• status_name — название статуса
• communication — список телефонов и электронной почты
• properties — свойства

Результат:

Будет возвращен json, в котором будет

• id — номер пользователя
• user_id — номер регистрации пользователя
• foto — ссылка на фотографию
• sex — код пола пользователя
• lastname — фамилия
• firstname — имя
• patronymic — отчество
• appeal — отображаемое имя
• birthday — дата рождения
• online — дата и время последнего посещения сайта
• company_id — id компании в которой работает
• post — должность в компании
• manager_id — ответственный менеджер
• date_insert — дата добавления пользователя в базу

Пример запроса

Получить контакты со статусом «Перспективный»

 /wp-json/usam/v1/contacts

{"status":"prospect"}

Получить сотрудников

 /wp-json/usam/v1/contacts

{"source":"employee"}

Получить контакты с дополнительными полями

 /wp-json/usam/v1/contacts

{"add_fields":["properties"]}

Поиск контактов по имени и получить дополнительные поля

 /wp-json/usam/v1/contacts

{"search":"Алексей","add_fields":["properties"]}

Получить контакт

Путь: /wp-json/usam/v1/contact

Метод запроса: GET

Результат:

Будет возвращен json, в котором будет

• id — номер пользователя
• user_id — номер регистрации пользователя
• foto — ссылка на фотографию
• sex — код пола пользователя
• lastname — фамилия
• firstname — имя
• patronymic — отчество
• appeal — отображаемое имя
• birthday — дата рождения
• online — дата и время последнего посещения сайта
• company_id — id компании в которой работает
• post — должность в компании
• manager_id — ответственный менеджер
• date_insert — дата добавления пользователя в базу

Так же к результату будут добавлены все свойства контакта, например:

{
    "mobilephone": {
        "id": 408,
        "name": "Мобильный телефон",
        "description": "",
        "type": "contact",
        "field_type": "mobile_phone",
        "group": "communication",
        "profile": 1,
        "mandatory": 0,   
        "show_staff": "1",
        "code": "mobilephone",
        "mask": "#(###)###-##-##",
        "value": "7(921)851-88-61",
        "communication_error": "",  
    },
    "email": {
        "id": 413,
        "name": "Email",
        "description": "",
        "type": "contact",
        "field_type": "email",
        "group": "communication",
        "profile": 1,
        "mandatory": 0,
        "show_staff": "1",
        "code": "email",
        "mask": "",
        "value": "it@radov39.ru",
        "reason": false,
        "communication_error": "",    
    },
}

Параметр value содержит значение свойства.

Создание контакта

Путь: /wp-json/usam/v1/сontact

Метод запроса: POST

• sex — код пола пользователя
• lastname — фамилия
• firstname — имя
• patronymic — отчество
• birthday — дата рождения

Свойства контакта добавляются к запросу по так

• email (строка) (обязательно) — почта;
• mobilephone (строка) (обязательно) — мобильный телефон;
• inn (строка) (обязательно) — инн;

Все доступные свойства смотрите на сайте в разделе настройки контакта.

Пример

/wp-json/usam/v1/contact

{"lastname":"Кузнецов","firstname":"Игорь", "email":office@wp-universam.ru,"mobilephone":79218018900}

Сохранение контакта

Путь: /wp-json/usam/v1/сontact/(номер)

Метод запроса: POST

• sex — код пола пользователя
• lastname — фамилия
• firstname — имя
• patronymic — отчество
• birthday — дата рождения

Свойства контакта добавляются к запросу по так

• email (строка) (обязательно) — почта;
• mobilephone (строка) (обязательно) — мобильный телефон;
• inn (строка) (обязательно) — инн;

Все доступные свойства смотрите на сайте в разделе настройки контакта.

Пример, обновим у созданного выше контакта имя и телефон

/wp-json/usam/v1/contact/1

{"firstname":"Сергей", "mobilephone":79211011111}