Получить компании
Путь: /wp-json/usam/v1/companies
Метод запроса: GET
- status — массив или строка, статус(не обязательный);
- status__not_in — массив или строка, исключить со статусом указанным в параметре(не обязательный);
- search — строка, поиск по номеру, названию, телефону, электронной почте, номеру счета (не обязательный);
- count — число, количество в одном запросе, по умолчанию 10 (не обязательный);
- paged — число, страница списка (не обязательный);
- fields — массив, какие данные вернуть, если указать metas будут дополнены свойствами(не обязательный).
Результат:
Будет возвращен json, в котором будет
- id — номер пользователя
- logo — ссылка на логотип
- name — название компании
- manager_id — ответственный менеджер
- date_insert — дата добавления в базу
Пример запроса
Получить компании со статусом «Перспективный»
/wp-json/usam/v1/companies
{"status":"prospect"}
Получить компании с дополнительными полями
/wp-json/usam/v1/companies
{"fields":["metas"]}
Поиск компаний по названию и получить дополнительные поля
/wp-json/usam/v1/companies
{"search":"алгоритм","fields":["metas"]}
Получить компанию по номеру
Путь: /wp-json/usam/v1/company/(номер)
Метод запроса: GET
Создать компанию
Путь: /wp-json/usam/v1/company
Метод запроса: POST
- name (строка) (обязательно) — название компании;
- status (строка) (не обязательно) — код статуcа;
- user_id (число) (не обязательно) — номер пользователя;
- type (строка) (не обязательно) — тип компании;
- user_id (число) (не обязательно) — номер пользователя;
- industry (строка) (не обязательно) — Сфера деятельности;
- date_insert (дата время) (не обязательно) — дата создания;
- parent_id (число) (не обязательно) — номер главной компании, если добавляется подразделение;
Свойства компании добавляются к запросу по так
- email (строка) (обязательно) — почта;
- mobilephone (строка) (обязательно) — мобильный телефон;
- inn (строка) (обязательно) — инн;
Все доступные свойства смотрите на сайте в разделе настройки компаний
Пример
/wp-json/usam/v1/company
{"name":"Aлгоритм","email":office@wp-universam.ru,"mobilephone":79218018900}
Обновить компанию
Путь: /wp-json/usam/v1/company/(номер)
Метод запроса: POST
- name (строка) (обязательно) — название компании;
- status (строка) (не обязательно) — код статуcа;
- user_id (число) (не обязательно) — номер пользователя;
- type (строка) (не обязательно) — тип компании;
- user_id (число) (не обязательно) — номер пользователя;
- industry (строка) (не обязательно) — Сфера деятельности;
- date_insert (дата время) (не обязательно) — дата создания;
- parent_id (число) (не обязательно) — номер главной компании, если добавляется подразделение;
Свойства компании добавляются к запросу по так
- email (строка) (обязательно) — почта;
- mobilephone (строка) (обязательно) — мобильный телефон;
- inn (строка) (обязательно) — инн;
Все доступные свойства смотрите на сайте в разделе настройки компаний
Пример, обновим у созданной выше компании Алгоритм название и телефон
/wp-json/usam/v1/company/10
{"name":"ООО Aлгоритм","mobilephone":79211000911}