История статусов сделки

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

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

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

Имя параметра Тип данных Описание
auth_key str токен авторизации для доступа к сервису
deal_id int id сделки 

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

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

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

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

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

GET https://domain.ru/rest/statushistory?deal_id=<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. Один кортеж в результате, режим по-умолчанию

[{
    "id": 9,
    "status": {
        "id": 72, 
        "title": "Marguerite Bins II", 
        "allowable_lifetime": 3891
    },
    "user": {
        "id": 13,
        "username": "nsatterfield",
        "email": "rosanna66@gmail.com",
        "role": 1,
        "status": 1,
        "created_at": 1414046324,
        "updated_at": 1414046324
    },
    "active": 1,
    "created_at": "2014-10-23 10:39:00",
    "lifetime": 3804
},{
    "..." 
}]

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

Заголовки

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

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

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

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