Комментарии к сделкам

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

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

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

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

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

Запрос списка комментариев для сделки <deal_id>

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

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

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

GET https://domain.ru/rest/comment?deal=<deal_id>&page=1&per_page=20&sort=-created_at

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

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

Допустимые параметры:
Таблица 1 

Имя параметра Тип данных Описание
deal_id int id сделки
page unsigned integer Не обязательное. Ограничивает результат списком клиентов для страницы page с учетом per_page
per_page unsigned integer Не обязательное. Ограничивает результат списком клиентов в количестве per_page
sort string Не обязательное. Указатель на необходимость сортировки по конкретному атрибуту сущности см. описание сущности client. Доступны только общие атрибуты.
fields string Не обязательное. Указатель на необходимость выборки конкретных атрибутов сущности. см Сущность "client". Доступны только общие 

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

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

{
  "response": {
    "items": [
      {
        "id": 123,
        "deal_id": 88,
        "user_id": 11,
        "username": "User name",
        "created_at": "20014-04-14 12:23:06",
        "comment": "hello, world",
        "history": {}
      },
      {
        "id": 124,
        "deal_id": 88,
        "user_id": 11,
        "username": "User name",
        "created_at": "20014-04-14 12:23:06",
        "comment": "hello, world 12",
        "history": {
            " // формат данных аналогичен Истории сделки" 
        }
      },
      ]
  }
}

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

Заголовки

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

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

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

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

Атрибут Тип данных Замечания
deal_id string id сделки
comment string Текст комментария

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

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

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

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

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