Удаление документа с открытым доступом
Метод Delete a free access document используется для удаления документа Реселлера с открытым доступом.
Доступ к текущему Реселлеру, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Сотрудника, указанному в заголовке запроса.
DELETE {base_url}/api/v3/resellers/{reseller_id}/free_access_documents/{free_access_document_id}
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
---|---|---|---|---|
X-Api-Token | header | string | Обязательный | API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) |
Content-Type | header | string | Обязательный | Предназначен для идентификации формата и способа представления сущности |
Accept | header | string | Обязательный | Предназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером) |
reseller_id | path | number | Обязательный | ID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере) |
free_access_document_id | path | number | Обязательный | ID документа |
Модель ответа
Название | Тип данных | Описание | ||||
---|---|---|---|---|---|---|
data | object | Данные ответа | ||||
id | string | ID документа в платформе | ||||
type | string | Тип данных | ||||
attributes | object | Информация о документе | ||||
created_at | string | Дата и время создания документа | ||||
updated_at | string | Дата и время последнего обновления документа | ||||
name | string | Название документа |
Пример запроса
DELETE /api/v3/resellers/1/free_access_documents/56
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
Пример ответа
{
"data": {
"id": "56",
"type": "free_access_documents",
"attributes": {
"created_at": "2020-10-09T16:49:19.699819+0300",
"updated_at": "2020-10-09T17:02:40.984184+0300",
"name": "1.pdf"
}
}
}