TM SDK Documentation 3.1.0
Дерево страниц

Метод: POST

Ресурс: event/texts

Параметры (передаются в виде JSON):

  • response_type — тип ответа:
    • chunked — используется  Transfer-Encoding: chunked , где каждый текст отдаётся в своём блоке и в порядке, переданном в теле запроса, если текста нет, то вместо текста передаётся null символ "\0"

    • multipart/mixed — используется формат multipart/mixed  rfc tech-ms , он не входит в стандарт HTTP, но используется в электронных письмах. Поэтому реализовать его не составляет труда. Так же он очень похож на  multipart/form-data . Каждый текст отдаётся в своём блоке и помечен отдельно заголовком X-Event-ID, к какому событию он принадлежит. Если текста нет, то оно либо не передаётся, либо тело этого текста отсутствует

  • events — массив объектов с полями:   

    • id — ID события

    • tbsId — Табличное пространство события

Примеры:

  chunked :

Запрос
 POST /xapi/event/texts
X-API-Version: 1.1
X-API-CompanyId: iw
X-API-ImporterName: dome
X-API-Auth-Token: brse99dugp1cdbr69axz
(пустая строка)
{"response_type": "chunked", "events": [{"id": 2, "tbsId": 4}, {"id": 4, "tbsId": 4}]}
Ответ
HTTP/1.1 200 OK
Content-Type: text/plain
Transfer-Encoding: chunked
(пустая строка)
1
\0 (символ отсутствия текста для события 2)
48AC
(содержимое текста для события 4)
0

multipart/mixed :

Запрос
POST /xapi/event/texts
X-API-Version: 1.1
X-API-CompanyId: iw
X-API-ImporterName: dome
X-API-Auth-Token: brse99dugp1cdbr69axz
(пустая строка)
{"response_type": "multipart/mixed", "events": [{"id": 2, "tbsId": 4}, {"id": 4, "tbsId": 4}]}
Ответ
HTTP/1.1 200 OK
Content-Type: multipart/mixed; boundary=Asrf456BGe4h
Content-Length: (суммарный объём, включая дочерние заголовки, может отсутствовать!)
(пустая строка)
(отсутствующая преамбула)
--Asrf456BGe4h
Content-Type: application/x-empty
Content-Disposition: attachment; filename="text-2.txt"
X-Event-ID: 2
(пустая строка и после нулевое содержимое)
--Asrf456BGe4h
Content-Disposition: attachment; filename="text-4.txt"
Content-Type: text/plain
X-Event-ID: 4
(пустая строка)
(содержимое текста для события 4)
--Asrf456BGe4h--
(отсутствующий эпилог - пустая строка)
  • Нет меток