Сделки (Deal)

Запросы осуществляются на URL:

https://domain.ru/rest/deal/[parameters]

Обязательные параметры:

  • access-token - токен авторизации для доступа к сервису

Получение списка

Запросы

Запрос списка в сокращенном виде:

GET https://domain.ru/rest/deal

Эквивалент для запроса

GET https://domain.ru/rest/deal/?page=1&per_page=10&sort=created_at

Возвращает список сделок с учетом постраничного вывода. Первые десять записей, отсортированные в порядке убывания даты создания. Возможно применение дополнительных параметров.

Допустимые параметры:

Таблица 1

Имя параметра Тип данных Описание
number string Указывает на необходимость фильтрации списка по значению атрибута number
name string Фильтр по строке названия сделки (LIKE%)
user_id integer Вводит ограничение на создавшего сделку пользователя системы с id равное user
client_id integer Вводит ограничение на клиента, как контрагента сделки с id равное client
contact_id integer Ограничивает результирующий набор конкретным контактом (сущность contact)
status_id integer Ограничивает результат списком сделок с конкретным статусом
performer_id integer Ограничивает результат списком сделок с участием исполнителя performer
page integer Ограничивает результат списком сделок для страницы page с учетом per_page
per_page integer Ограничивает результат списком сделок в количестве per_page
sort string Указатель на необходимость сортировки по конкретному атрибуту сущности
fields string Указатель на необходимость конкретных атрибутов сущности. см Сущность "Сделка"
expand string Список связных сущностей, которые нужно развернуть
search string Составной фильтр поиска по значащим текстовым полям
year integer{4} Ограничивает результирующий набор конкретным годом создания сделки
month integer[1..12] Ограничивает результирующий набор конкретным месяцем создания сделки 

Формат ответов

1. Один кортеж в результате, режим по-умолчанию 

{
  "response": {
    "items": [
      {
        "id": 123,
        "number": "000123",
        "tite": "OwnCompan ltd",
        "user_id": 12,
        "client": {
          "id":1,
          "name": "Test", 
          "type": 1
        },
        "contact": 14,
        "status": 1,
        "performer": 12,
        "created_at": "20014-04-14 12:23:06",
        "updated_at": "20014-04-14 12:23:06" 
      }
      ]
  }
}

1. Один кортеж в результате, режим expand


< response>
< item>
< id>84< /id>
< number>30047< /number>
< name>Hilll LLC< /name>
< user_id>30< /user_id>
< user_name>baumbach.donny< /user_name>
< client>
< id>34< /id>
< name>Miss Helga Yost I< /name>
< user_id>20< /user_id>
< type_id>1< /type_id>
< email>toney.klein@yahoo.com< /email>
< phone>675-969-5482x09431< /phone>
< real_address>51587 Cassin Islands Apt. 078South Mazie, NH 16345-4577< /real_address>
< description>h< /description>
< created_at>2014-10-22 16:45:13< /created_at>
< updated_at>2014-10-22 16:45:13< /updated_at>
< /client>
< status>Gunnar Quigley< /status>
< contact_id>42< /contact_id>
< status_id>72< /status_id>
< performer_id>82< /performer_id>
< template_id>1< /template_id>
< created_at>2014-10-22 16:45:14< /created_at>
< updated_at>2014-10-22 16:45:14< /updated_at>
< /item>

Постраничная навигация

Заголовки
X_Pagination_Total_Count: общее количество ресурсов;
X_Pagination_Page_Count: количество страниц;
X_Pagination_Current_Page: текущая страница (начиная с 1);
X_Pagination_Per_Page: количество ресурсов на страницу;
Ссылки
<https://max.crm.ru/rest/client?access-token=<token>[&param1=value1[&...]]>; rel=self,
<https://max.crm.ru/rest/client?access-token=<token>[&param1=value1[&...]]>; rel=next, 
<https://max.crm.ru/rest/client?access-token=<token>[&param1=value1[&...]]>; rel=last

Получение по идентификатору

Запрос

Запрос в сокращенном виде:

GET https://domain.ru/rest/deal/<deal_id>

Возвращает карточку сделки.
Возможно применение дополнительных параметров.

Допустимые параметры:

Таблица 2

Имя параметра Тип данных Описание
fields string Указатель на необходимость конкретных атрибутов сущности. см Сущность "Сделка"
expand string Содержит список сущностей, которые требуется развернуть 

Формат ответов

Идентичен формату для списка

Добавление данных

POST https://domain.ru/rest/deal

Таблица 3 - Набор атрибутов при добавлении

Атрибут Тип данных Замечания
number string Необязательный. В случае, если не передан, заполняется на сервере
name string  
client_id integer Обязательный, передает идентификатор сущности "Client"
contact_id integer Не обязательный, передает идентификатор сущности "Contact"
status_id integer Не обязательный, может присваиваться на сервере автоматически, согласно трекеру. В случае запонения используется идентификатор соотв. сущности
performer_id integer Обязательное, передает идентификатор сущности "Performer"
template_id integer Обязательное, передает идентификатор шаблона 

При создании в историю смены статусов должна добавиться новая запись с id текущего статуса для сделки.

Формат ответов

В случае успешного выполнения запроса:
  • Сервер возвращает код ответа 200
  • В теле ответа приходит вновь добавленная сущность в формате запроса по идентификатору (см. Получение-по-идентификатору )
В случае ошибки возвращается код ответа, отличный от 200

Изменение данных

PUT https://domain.ru/rest/deal/<deal_id>
PATCH https://domain.ru/rest/deal/<deal_id>

Тело запроса формируется идентичным запросу на добавление. Набор атрибутов идентичен. Формат ответов идентичен.

При изменении статуса заказа формируется новая запись в истории смены статусов. Старая при этом должна изменить свое значение lifetime на количество дней от даты создания до текущей.

Удаление данных

DELETE https://domain.ru/rest/deal/<deal_id>

Тело запроса отсутствует

Формат ответов

Возвращает код ответа от сервера 200 в случае успешного выполнения запроса либо отличный от него в случае возникновения ошибки.

Документация

© «Копирайт», 2017

Web-canape - быстрое создание сайтов и продвижение