Получение списка комментариев

Метод Get list of notes используется для получения списка комментариев к сущностям платформы.

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

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

GET {base_url}/api/v3/resellers/{reseller_id}/notes

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
X-Api-Token	header	string	Обязательный	API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_url	path	string	Обязательный	URL ActivePlatform
reseller_id	path	integer	Обязательный	ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
page[size]	query	integer	Опциональный	Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)
page[number]	query	integer	Опциональный	Параметр постраничной навигации. Номер страницы ответа
filter[account_id]	query	string	Опциональный	Предназначен для фильтрации списка комментариев по ID клиента. Допускается указание нескольких значений, разделенных запятой
filter[subscription_id]	query	string	Опциональный	Предназначен для фильтрации списка комментариев по ID подписки. Допускается указание нескольких значений, разделенных запятой
filter[order_id]	query	string	Опциональный	Предназначен для фильтрации списка комментариев по ID заказа. Допускается указание нескольких значений, разделенных запятой

Модель ответа

Название				Тип данных	Описание
data				array of objects	Данные ответа
	id			string	ID комментария
	type			string	Тип данных
	attributes			object	Информация о комментарии
		created_at		string	Дата и время создания комментария
		updated_at		string	Дата и время последнего изменения комментария
		content		string	Текст комментария
		creator		string	Информация о том, кто добавил комментарий: Имя менеджера, добавившего комментарий. Системный — комментарий был добавлен автоматически.
		original_link		string	Ссылка на комментарий
		original_id		integer	ID сущности в платформе, к которой относится комментарий. Для комментариев, которые относятся к сущности Клиент, `original_id = null`
		original_type		string	Тип сущности в платформе, к которой относится комментарий. Возможные значения: null — Клиент. Subscription — Подписка. Order — Заказ. ManualOperation — Ручная операция. Discount — Скидка.
		attachment		object	Информация о файле, прикрепленном к комментарию. Если файла нет, `attachment = null`
			name	string	Название файла
			url	string	Ссылка на файл
			size	string	Размер файла в байтах
links				array	Ссылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации
	self			string	Ссылка на текущую страницу
	first			string	Ссылка на первую страницу
	prev			string	Ссылка на предыдущую страницу
	next			string	Ссылка на следующую страницу
	last			string	Ссылка на последнюю страницу

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

GET /api/v3/resellers/1/notes
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

Пример ответа

{
    "data": [
        {
            "id": "5",
            "type": "notes",
            "attributes": {
                "created_at": "2023-03-27T11:35:12.509+03:00",
                "updated_at": "2023-03-27T11:35:12.509+03:00",
                "content": "Migrated",
                "creator": "Bill Smith",
                "original_link": "/admin/accounts/29/notes/5",
                "original_id": null,
                "original_type": null,
                "attachment": {
                    "name": "Logo",
                    "url": "https://storage.test.activeplatform.com/private/uploads/note/attachment/5/Logo?expires=1680009898&hash=DStusb6w",
                    "size": 3439
                }
            }
        },
        {
            "id": "12",
            "type": "notes",
            "attributes": {
                "created_at": "2023-03-27T13:33:00.320+03:00",
                "updated_at": "2023-03-27T13:33:00.320+03:00",
                "content": "Migrated subscription",
                "creator": "Angela Grand",
                "original_link": "/admin/subscriptions/114/notes/12",
                "original_id": 114,
                "original_type": "Subscription",
                "attachment": {
                    "name": "google114.png",
                    "url": "https://storage.test.activeplatform.com/private/uploads/note/attachment/12/google114.png?expires=1680009898&hash=9gwX6Thg",
                    "size": 3428
                }
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/1/notes?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "first": "https://test.activeplatform.com/api/v3/resellers/1/notes?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "prev": null,
        "next": null,
        "last": "https://test.activeplatform.com/api/v3/resellers/1/notes?page%5Bnumber%5D=1&page%5Bsize%5D=50"
    }
}