Загрузка файлов

Загрузка файлов

POST https://crm.lotinfo.ru/upload

Эта конечная точка позволяет загрузить файл в систему. После загрузки файла Вы получите токен, по которому сможете добавить файл на объект, если это фото объекта, и на объект, клиента или сотрудника, если это документ. Добавление файла описано ниже.

Query Parameters

Name	Type	Description
token*	string	Ваш токен. Примечание: указывать токен от API, не путать с токеном файла (fileToken).

Request Body

Name	Type	Description
file	object	Загружаемый файл. Тип: файл (изображение).
type*	string	Тип файла. Значения: "object" - Фото объекта, "document" - Документ. Примечание: фото объекта может быть прикреплено только к объекту, документ может быть прикреплен к объекту, клиенту или сотруднику.

200 Пример ответа. Для следующего шага нужен токен файла - "fileToken".

{"lid":null,"options":[],"fileToken":"88261162-d5329e10773c8eb5673e0e32f4e97cf9"}

400 Пример ответа на запрос с ошибкой. (Ответ сервера будет с кодом 200.)

{"lid":null,"options":[],"uploadInfo":{"error":1,"description":"<font size=3>Ошибка авторизации<\/font>"}}

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

<form enctype="multipart/form-data" method="post" action="https://crm.lotinfo.ru/upload/?TOKEN={ваш_токен}">
    <input type="file" name="file">
    <input type="text" name="type" value="object">
    <input type="submit" value="Отправить">
</form>

Добавление загруженных файлов

PUT https://api.lotinfo.ru/v1/DOCS

Эта конечная точка позволяет прикрепить загруженные файлы к объектам, клиентам и сотрудникам по полученным при загрузке файлов токенам.

Query Parameters

Name	Type	Description
token*	string	Ваш токен. Примечание: указывать токен от API, не путать с токеном файла (fileToken).

Request Body

Name	Type	Description
encoding	integer	Кодировка. Значения: 0 - не кодировать, 1 - кодировать. По умолчанию: 0. Пример закодированных символов: "\u0423\u043a\u0430\u0436".
data*	array	Массив с данными о добавляемых файлах. Параметры данных: - fileToken (string, required) - Токен файла, полученный при его загрузке. - userId (integer) - ID пользователя. - type (string, required) - Тип файла. Значения: "object" - Фото объекта, "document" - Фото документа. Примечание: тип файла при загрузке и при добавлении должен быть одинаковый. Следующие параметры указываются в зависимости от выбранного типа файла: Для типа "object": - objectId (integer, required) - ID объекта, к которому надо прикрепить файл. Примечание: объект должен принадлежать пользователю. Для типа "document": - mergeType (string, required) - Выбор, к чему присоединить файл. Значения: "object" - к объекту, "client" - к клиенту, "user" - к сотруднику. - mergeId (integer, required) - ID объекта, клиента или сотрудника. Примечание: объект, клиент или сотрудник с указанным ID должен принадлежать пользователю. Если mergeType = "object", также указываются параметры (для "document"): - fileParam (integer, required) - Тип документа. Значения: 1 - Документы основания, 3 - Иные документы. - fileName (string, required) - Название документа. Значения: Если fileParam=1, то указывается число, соответствующее нужному названию: "0" - Проектная декларация, "1" - Генеральный план, "2" - Справка ЕГРП, "3" - Справка ЕГРН, "4" - Договор передачи квартиры в собственность граждан, "5" - Договор купли продажи, "6" - Договор мены, "7" - Договор дарения, "8" - Договор долевого участия в строительстве", "9" - Свидетельство о праве на наследство по закону, "10" - Свидетельство о праве на наследство по завещанию, "11" - Решение суда, "12" - Справка о выплате, "13" - Разрешение на ввод объекта в эксплуатацию, "14" - Свидетельство о государственной регистрации права, "15" - Кадастровый паспорт, "16" - Технический паспорт, "17" - Коммуникации. Если fileParam=3, то указывается своё текстовое значение. Если mergeType = "client", также может быть указан параметр (для "document"): - fileName (string) - Название документа.

200 Пример ответа (на запрос из примера ниже).

HTTP/1.1 200 OK
Content-Type: application/json

{
  "result": [
    {
      "id": 654
    },
    {
      "id": 655
    },
    {
      "id": 656
    },
    {
      "id": 657
    },
  ]
}

400 Пример ответа на запрос с ошибкой. (Ответ сервера будет с кодом 200.)

HTTP/1.1 200 OK
Content-Type: application/json

{
  "errors": [
    {
      "error": 42,
      "error_text": "Значение поля type должно быть таким же, как при загрузке файла.",
      "error_field": "type",
      "error_array": 2
    }
  ]
}

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

PUT https://api.lotinfo.ru/v1/DOCS/?TOKEN={ваш_токен} HTTP/1.1
Content-Type: application/json

{
  "data": [
    {
      "fileToken": "654-202cb962ac59075b964b07152d234b70",
      "userId": 123,
      "type": "object",
      "objectId": 101
    },
    {
      "fileToken": "655-81dc9bdb52d04dc20036dbd8313ed055",
      "userId": 123,
      "type": "document",
      "mergeType": "object",
      "mergeId": 101,
      "fileParam": "1",
      "fileName": "3"
    },
    {
      "fileToken": "656-827ccb0eea8a706c4c34a16891f84e7b",
      "userId": 123,
      "type": "document",
      "mergeType": "client",
      "mergeId": 2003,
      "fileName": "Док"
    },
    {
      "fileToken": "657-e10adc3949ba59abbe56e057f20f883e"
      "userId": 123,
      "type": "document",
      "mergeType": "user",
      "mergeId": 989
    }
  ]
}