import_messages
To import messages from a file, use the exchange/import_messages command.
svc=exchange/import_messages¶ms={"itemId":<long>,
"eventHash":<text>}
This request can’t be executed simultaneously with any request from this chapter and the following requests:
- …/report/exec_report,
- …/report/export_result,
- …/report/get_result_chart,
- …/report/get_result_map,
- …/messages/load_interval,
- …/render/create_messages_layer,
- …/unit/get_trips,
- …/resource/get_driver_bindings,
- …/resource/get_trailer_bindings,
- …/account/get_account_history.
Parameters
The required parameter is marked with an asterisk (*).
Name | Description |
itemId* | Item ID. |
eventHash | Event name, which will be generated after messages are imported. |
dontMarkImported | If this parameter is set to 1, imported messages will not be marked as imported but as blackbox; the registration time may differ from the message time. If this parameter is missing or set to a value other than 1, messages will be marked as imported. |
Loading a file
To load a file, use a POST request with multiple contents (multipart/form-data). For example:
Request URL: https://hst-api.wialon.com/wialon/ajax.html?svc=exchange/import_messages&sid=8157df114c0e601f0f31091c3c2ac53d
Request Method: POST
Connection: keep-alive
Content-Length: 2744
Cache-Control: no-cache
Content-Type: multipart/form-data; boundary=----WebKitFormBoundarylvunQiir9AesO8qB
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Accept-Charset: windows-1251,utf-8;q=0.7,*;q=0.3
Accept-Encoding: gzip,deflate,sdch
Accept-Language: ru,en-US;q=0.8,en;q=0.6
------WebKitFormBoundarylvunQiir9AesO8qB
Content-Disposition: form-data; name="params"
{"itemId":898446,"eventHash":"jUploadForm1372773585167"}
------WebKitFormBoundarylvunQiir9AesO8qB
Content-Disposition: form-data; name="eventHash"
jUploadForm1372773585167
------WebKitFormBoundarylvunQiir9AesO8qB
Content-Disposition: form-data; name="messages_filter_import_file"; filename="4100.zip"
Content-Type: application/zip
------WebKitFormBoundarylvunQiir9AesO8qB--
Response
If the request is completed successfully, an empty response is returned.
{ }
To make sure that the messages have been imported, you can execute the …/requests/avl_evts command.
{
"tm": <uint>, /* current server time (UTC) */
"events": [{
"i": -1,
"d": { /* data */
"hash": <text>, /* upload complete */
"msgCount": <text> /* number of imported messages */
}]
}
If the request is not completed, an error code is returned.
Error codes
Code | Description |
1 | Invalid or obsolete request SID. |
4 | No file attached. |
6 | Internal error. |
7 | One of the following errors:
|