Наверх

API-метод удаления импортированных данных

Описание

API-метод позволяет удалять импорты, отображаемые в разделе «Ручной ввод данных», таб «Лог»:

mceclip1.png

Запрос

POST: https://api.calltouch.ru/report-service/RestAPI/api/users-import/delete

HTTP-заголовки:

  • Access-Token – API-ключ
  • SiteId – ID ЛК Calltouch

Тело запроса в формате JSON:

{
"importLogIds": [ID_импорта_1, ID_импорта_2, ID_импорта_N]
}
Параметры запроса
На вход подается только список ID импортов. В одном запросе можно указать не более 100 импортов. Получить идентификаторы можно двумя способами:
  1. В ответе на успешный API-запрос импорта расходов или импорта плановых метрик;
  2. В интерфейсе Личного кабинета Calltouch, раздел «Ручной ввод данных», таб «Лог»:

mceclip0.png

Ответ

Процесс удаления запускается сразу же после отправки запроса, после чего сразу же возвращается и ответ, пример:

{
"meta": [],
"data": {
"importLogs": [
{
"importLogId": 123,
"deleteStatus": "success",
"error": null
},
{
"importLogId": 124,
"deleteStatus": "success",
"error": null
}
]
}
}

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

Параметр Формат Описание
data.importLogs[n].importLogId integer Переданный ID сделки из внешний CRM в запросе на обновление.
data.importLogs[n].deleteStatus string

Статус удаления. Возможные значения:

  • success
  • error
data.importLogs[n].error object Отображается причина ошибки удаления

 

Ошибки

1. Ошибка авторизации

{
"message": "Access token не найден"
}

2. Ошибка формата тела запроса

{
"meta": [],
"data": {
"type": "apiError",
"apiErrorData": {
"errorCode": 1,
"errorMessage": "Синтаксическая ошибка JSON в запросе или запрос пустой",
"errorDescription": null
},
"validationErrorData": null
}
}

3. Отсутствие обязательных полей в запросе

{
"meta": [],
"data":
{
"message": "В запросе не указано обязательное поле \"importLogIds\""
}
}

4. Невалидный элемент массива

{
"meta": [],
"data": {
"type": "validationError",
"apiErrorData": null,
"validationErrorData": {
"violations": [
{
"fieldPath": "importLogIds[2]",
"message": "Невалидное значение."
}
]
}
}
}

5. Один из идентификаторов не найден

{
"meta": [],
"data": {
"type": "validationError",
"apiErrorData": null,
"validationErrorData": {
"violations": [
{
"importLogId": 123,
"deleteStatus": "success",
"error": null
},
{
"importLogId": 124,
"deleteStatus": "error",
"error": "Указанный идентификатор импорта не найден."
}
]
}
}
}