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

Метод Get a List of the free access documents используется для получения списка документов Реселлера с открытым доступом.

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

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

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
X-Api-Token	header	string	Обязательный	API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-Type	header	string	Обязательный	Предназначен для идентификации формата и способа представления сущности
Accept	header	string	Обязательный	Предназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером)
reseller_id	path	number	Обязательный	ID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере)

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

Название			Тип данных	Описание
data			array of objects	Данные ответа
	id		string	ID документа в платформе
	type		string	Тип данных
	attributes		object	Информация о документе
		created_at	string	Дата и время создания документа
		updated_at	string	Дата и время последнего обновления документа
		name	string	Название документа
		url	string	Новая ссылка на документ в файловом хранилище

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

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

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

{
    "data": [
        {
            "id": "51",
            "type": "free_access_documents",
            "attributes": {
                "created_at": "2020-10-08T02:11:20.932646+0300",
                "updated_at": "2020-10-08T02:11:20.932646+0300",
                "name": "1.pdf",
                "url": "https://storage.test.activeplatform.com/public/free_access_documents/731c1c83578f8a7c14d0173dadbc72f1.pdf"
            }
        },
        {
            "id": "52",
            "type": "free_access_documents",
            "attributes": {
                "created_at": "2020-10-08T02:16:43.247122+0300",
                "updated_at": "2020-10-08T02:16:43.247122+0300",
                "name": "2.pdf",
                "url": "https://storage.test.activeplatform.com/public/free_access_documents/7610e1125f87af27367d53b58661975a.pdf"
            }
        },
        {
            "id": "55",
            "type": "free_access_documents",
            "attributes": {
                "created_at": "2020-10-09T16:49:12.819600+0300",
                "updated_at": "2020-10-09T16:49:12.819600+0300",
                "name": "5.pdf",
                "url": "https://storage.test.activeplatform.com/public/free_access_documents/b482623013d660c59bace40c4dcec419.pdf"
            }
        }
    ]
}